电子披露声明（EDS）API客户端

此驱动程序允许其他项目与芝加哥市的EDS系统交互。

设置

依赖项

• lxml
• scrapelib

安装

eds-api-client可以通过pip安装。

用法

此驱动程序提供三个端点。为了成功实例化EDSAPIClient类，请提供client_id、client_secret和domain的值。如果没有提供domain，则默认值为https://apiqa.chicago.gov

此驱动程序提供三个主要功能

1. 注册用户

new_user_response = api_client.register_user(registration_data,
                                             app_username=client_username,
                                             app_password=client_password)

2. 登录用户

response = api_client._get_access_token(client_username, client_password)

3. 提交EDS

response = api_client.submit_eds(submission_data, client_username, client_password)

开发

克隆此存储库，创建虚拟环境，然后安装软件包并测试要求。

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

要运行测试

pytest -sv

版权和归属

版权（c）2023 DataMade。在MIT许可证下发布。