Boilerplate SDK in Python
Boilerplate for making your own SDK in Python
Install
$ pipenv install "git+https://github.com/SFDigitalServices/boilerplate-sdk-py.git@master#egg=boilerplate-sdk"
Example usage
from boilerplate_sdk.example import Example
example = Example()
posts = example.get_posts({'userId':'1'})
Tests
pipenv run python -m pytest tests/ --cov=boilerplate_sdk --cov-report term-missing
Example app
Start up example app
pipenv run gunicorn --reload 'examples.app:run()'
Run test for example app
pipenv run python -m pytest examples/ --cov=examples/ --cov-report term-missing
Generate Documentation
with Pdoc
(cd docs/pdoc && pipenv run python -m pdoc --html ../../boilerplate_sdk/sdk.py)
with Sphinx
(cd docs/sphinx && pipenv run make html)