/accela-rest-sdk-py

Python package for working with the Accela REST API.

Primary LanguagePythonMIT LicenseMIT

Accela REST SDK in Python CircleCI Coverage Status Documentation Status

Accela REST SDK in Python

Install

$ pipenv install "git+https://github.com/SFDigitalServices/accela-rest-sdk-py.git@master#egg=accela-rest-sdk"

Example usage

from accela_rest_sdk.accela import Accela

config = {'APP_ID' : '123', 'APP_SECRET' : 'ABC', 'AGENCY' : 'AGENCY_NAME'}
accela = Accela(config)

record_id = "AGENCY-ABCDEF-00000-00123"
record_response = accela.records.get_records(record_id)

Tests

pipenv run python -m pytest tests/ --cov=accela_rest_sdk --cov-report term-missing

Example app

Start up example app

pipenv run gunicorn --reload 'examples.accela_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 ../../accela_rest_sdk/sdk.py)

with Sphinx

(cd docs/sphinx && pipenv run make html)