Electronic Disclosure Statement (EDS) API Client
This driver allows other projects to interact with the City of Chicago's EDS system.
Setup
Dependencies
Installation
eds-api-client
is installable via pip.
Usage
This driver provides three endpoints. In order to succesfully instantiate the EDSAPIClient
class, provide values for client_id
, client_secret
, and domain
. If no domain
is provided, the default value is https://apiqa.chicago.gov
This driver provides three main functions:
- Register a user
new_user_response = api_client.register_user(registration_data,
app_username=client_username,
app_password=client_password)
- Log in a user
response = api_client._get_access_token(client_username, client_password)
- Submit an EDS
response = api_client.submit_eds(submission_data, client_username, client_password)
Development
Clone this repository, create a virtual environment, then install the package and test requirements.
git clone https://github.com/datamade/eds-api-client.git
python3 -m venv ~/.virtualenvs/python-eds-client
source ~/.virtualends/python-eds-client
pip install -e .
pip install -r test_requirements.txt
To run the tests:
pytest -sv
Copyright and attribution
Copyright (c) 2023 DataMade. Released under the MIT License.