-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e451b8e
commit 388720f
Showing
1 changed file
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# pydocket | ||
|
||
Python library for the [Regulations.gov API](https://regulationsgov.github.io/developers/index.html). | ||
|
||
## Getting Started | ||
|
||
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. | ||
|
||
### Prerequisites | ||
|
||
Python 3 (not tested on Python 2) | ||
|
||
### Installing | ||
|
||
Not yet on PyPI, so install using [`pip`'s VCS support](https://pip.pypa.io/en/stable/reference/pip_install/#vcs-support): | ||
|
||
``` | ||
pip install git+https://github.com/gregoryfoster/pydocket.git | ||
``` | ||
|
||
## Running the tests | ||
|
||
Uses `pytest` fixtures and `VCR`. | ||
|
||
``` | ||
git clone https://github.com/gregoryfoster/pydocket.git | ||
pip install requirements.txt | ||
cd tests | ||
python test_pydocket.py | ||
``` | ||
|
||
## Built With | ||
|
||
* [requests](http:https://docs.python-requests.org/en/master/) - HTTP for humans by [@kennethreitz](https://github.com/kennethreitz) | ||
|
||
## Contributing | ||
|
||
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. | ||
|
||
## Versioning | ||
|
||
We use [SemVer](http:https://semver.org/) for versioning. Releases are documented as [tags on this repository](https://github.com/gregoryfoster/pydocket/tags). | ||
|
||
## Authors | ||
|
||
* **Gregory Foster** - *Initial work* - [@gregoryfoster](https://github.com/gregoryfoster) | ||
|
||
See also the list of [contributors](https://github.com/gregoryfoster/pydocket/contributors) who participated in this project. | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details | ||
|
||
## Acknowledgments | ||
|
||
* Initial development follows [@kevgathuku's](https://github.com/kevgathuku) article ["Building and Testing an API Wrapper in Python"](https://semaphoreci.com/community/tutorials/building-and-testing-an-api-wrapper-in-python) |