generated from Hazel/python-project
added proper readme
This commit is contained in:
parent
616c3485de
commit
7dbdc39621
40
README.md
40
README.md
@ -4,14 +4,42 @@ A Python library for simplified HTTP requests, featuring rate limiting, browser-
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- saving responses to cache
|
- Save responses to cache
|
||||||
|
- Use any session (e.g., bypass Cloudflare using [cloudscraper](https://pypi.org/project/cloudscraper/))
|
||||||
|
- Configurable wait between requests without thread blocking
|
||||||
|
- Automatic retries for failed requests
|
||||||
|
|
||||||
## ToDo
|
## Installation
|
||||||
|
|
||||||
- [ ] basic structure
|
```bash
|
||||||
- [x] caching
|
pip install python-requests
|
||||||
- [ ] add cloudscraper
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Basic Usage
|
||||||
|
|
||||||
|
```python
|
||||||
|
from python_requests import Connection, set_cache_directory
|
||||||
|
|
||||||
|
set_cache_directory("/tmp/your-project")
|
||||||
|
connection = Connection()
|
||||||
|
|
||||||
|
response = connection.get("https://example.com")
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using with Cloudscraper
|
||||||
|
|
||||||
|
```python
|
||||||
|
from python_requests import Connection, set_cache_directory
|
||||||
|
import cloudscraper
|
||||||
|
|
||||||
|
set_cache_directory("/tmp/your-project")
|
||||||
|
connection = Connection(cloudscraper.create_scraper())
|
||||||
|
|
||||||
|
response = connection.get("https://example.com")
|
||||||
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the [**🏳️🌈 Opinionated Queer License v1.2**](https://oql.avris.it/license). So use is strictly prohibited for cops, military and everyone who actively works against human rights.
|
This project is licensed under the [**🏳️🌈 Opinionated Queer License v1.2**](https://oql.avris.it/license). So use is strictly prohibited for cops, military and everyone who actively works against human rights.
|
Loading…
x
Reference in New Issue
Block a user