takunomi-build-bot
5bc55b93e0
This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager
64 lines
1.8 KiB
Markdown
64 lines
1.8 KiB
Markdown
<!--- WARNING --->
|
|
<!--- THIS IS AN AUTO-GENERATED FILE --->
|
|
<!--- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN --->
|
|
|
|
|
|
|
|
# Requests utilities
|
|
|
|
 
|
|
|
|
Utility for standarized usage of HTTP requests extension libraries in a modular fashion across different libraries.
|
|
|
|
Currently supports [`requests_cache`](https://requests-cache.readthedocs.io) and [`requests_ratelimiter`](https://github.com/JWCook/requests-ratelimiter).
|
|
|
|
The intention is that a libraries can automatically setup ratelimiting for
|
|
their specific use cases, as the library most likely has a better
|
|
understanding of the ratelimiting and caching behaviour of their associated websites than the user has.
|
|
|
|
## Dependencies
|
|
|
|
This project requires [Python](https://www.python.org/) 3.8 or newer.
|
|
|
|
All required libraries can be installed easily using:
|
|
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
Full list of requirements:
|
|
- [requests](https://pypi.org/project/requests/)
|
|
- [requests_ratelimiter](https://pypi.org/project/requests_ratelimiter/)
|
|
- [requests_cache](https://pypi.org/project/requests_cache/)
|
|
|
|
|
|
## Contributing
|
|
|
|
Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so.
|
|
|
|
|
|
### Testing
|
|
|
|
Testing requires the [pytest](https://docs.pytest.org/en/stable/) library.
|
|
|
|
Run tests with the following command:
|
|
|
|
```sh
|
|
pytest test
|
|
```
|
|
|
|
Test coverage can be run using the [`pytest-cov`](https://pypi.org/project/pytest-cov/) extension:
|
|
|
|
```sh
|
|
pytest --cov=requests_util test
|
|
```
|
|
|
|
|
|
## License
|
|
|
|
```
|
|
Copyright (c) 2024-2025 Jon Michael Aanes
|
|
|
|
All rights reserved.
|
|
```
|