Metadata-Version: 2.1
Name: silver-surfer-models
Version: 0.0.25.dev0
Summary: MySQL db models
Home-page: https://github.com/harsh376/silver-surfer-models
Author: Harsh Verma
Author-email: harsh376@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Requires-Python: ~=3.6
Description-Content-Type: text/markdown
Requires-Dist: marshmallow (==2.10.5)
Requires-Dist: PyMySQL (==0.9.3)
Requires-Dist: python-dateutil (==2.8.0)
Requires-Dist: pytz (==2019.1)
Requires-Dist: SQLAlchemy (==1.2.15)
Requires-Dist: boto3 (==1.9.134)
Requires-Dist: botocore (==1.12.134)
Requires-Dist: s3transfer (==0.2.0)
Requires-Dist: six (==1.12.0)
Requires-Dist: urllib3 (==1.24.2)
Requires-Dist: dnspython (==1.16.0)
Requires-Dist: pymongo (==3.8.0)

## silver-surfer-db-models

This package provides a reusable abstraction to connect to the silver surfer
database.

### Commands

**List commands**

`inv -l`

### Usage

**Configure the database in your app**

```
from silver_surfer_models.database import get_db_session

db_uri = 'mysql+pymysql://%s:%s@%s/%s?charset=utf8mb4' % (
    'root',
    'password',
    'host',
    'db',
)
engine, db_session, Base = database.get_db_session(db_uri)

```

### How to release a new version?

**Update the `version` in `setup.py`**

```
setuptools.setup(
    ...
    version='0.0.9',
    ...
)
```

**Build the wheel**

```inv build```

**Upload the wheel to PyPi repository**

```inv push```


