From 4367d95745463887f003e117c37a86bc90db33fb Mon Sep 17 00:00:00 2001 From: Jon Michael Aanes Date: Mon, 8 Jul 2024 19:00:47 +0200 Subject: [PATCH] Module Docstring --- README.md | 9 --------- requests_util/__init__.py | 11 ++++++++++- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0c423c6..e69de29 100644 --- a/README.md +++ b/README.md @@ -1,9 +0,0 @@ -# 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. diff --git a/requests_util/__init__.py b/requests_util/__init__.py index c771ea1..716e893 100644 --- a/requests_util/__init__.py +++ b/requests_util/__init__.py @@ -1,4 +1,13 @@ -"""Utility module for setting up ratelimiting on third-party sessions.""" +"""# 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. +""" import logging import pathlib