Python library for the Regulations.gov API.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Python 3 (not tested on Python 2)
You'll need to acquire a Data.gov API Key to perform queries.
Clone, create a Python 3 virtual environment, and install requirements.
git clone https://github.com/gregoryfoster/pydocket.git
cd pydocket
virtualenv -p $(which python3) .venv
source .venv/bin/activate
pip install requirements.txt
Export your Data.gov API key in your development environment to perform queries:
export DATA_GOV_API_KEY=[your_api_key_here]
See the tests and download.py for examples of usage.
Uses pytest fixtures and VCR.
cd tests
python test_pydocket.py
Not yet on PyPI, so deploy using pip's VCS support:
mkdir your_project
cd your_project
virtualenv -p $(which python3) .venv
source .venv/bin/activate
pip install git+https://github.com/gregoryfoster/pydocket.git
- requests - HTTP for humans by @kennethreitz
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. Releases are documented as tags on this repository.
- Gregory Foster - Initial work - @gregoryfoster
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE file for details
- Initial development follows @kevgathuku's article "Building and Testing an API Wrapper in Python"