From 7dbdc39621d22dda0de53ecadad9e1abb14a1497 Mon Sep 17 00:00:00 2001 From: Hazel Noack Date: Wed, 11 Jun 2025 15:30:28 +0200 Subject: [PATCH] added proper readme --- README.md | 40 ++++++++++++++++++++++++++++++++++------ 1 file changed, 34 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9445825..07f1a6b 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,42 @@ A Python library for simplified HTTP requests, featuring rate limiting, browser- ## 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 -- [x] caching -- [ ] add cloudscraper +```bash +pip install python-requests +``` + +## 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 -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. \ No newline at end of file