A transparent, persistent cache for the requests library
Project description
Requests-Cache
Summary
requests-cache is a transparent, persistent HTTP cache for the python requests library. It's a convenient tool to use with web scraping, consuming REST APIs, slow or rate-limited sites, or any other scenario in which you're making lots of requests that are expensive and/or likely to be sent more than once.
See full project documentation at: https://requests-cache.readthedocs.io
Features
- Ease of use: Use as a drop-in replacement
for
requests.Session, or install globally to add caching to allrequestsfunctions - Customization: Works out of the box with zero config, but with plenty of options available for customizing cache expiration and other behavior
- Persistence: Includes several storage backends: SQLite, Redis, MongoDB, GridFS, DynamoDB, and filesystem.
- Compatibility: Can be used alongside other popular libraries based on requests
Quickstart
First, install with pip:
pip install requests-cache
Next, use requests_cache.CachedSession to send and cache requests. To quickly demonstrate how to use it:
This takes ~1 minute:
import requests
session = requests.Session()
for i in range(60):
session.get('http://httpbin.org/delay/1')
This takes ~1 second:
import requests_cache
session = requests_cache.CachedSession('demo_cache')
for i in range(60):
session.get('http://httpbin.org/delay/1')
The URL in this example adds a delay of 1 second, simulating a slow or rate-limited website.
With caching, the response will be fetched once, saved to demo_cache.sqlite, and subsequent
requests will return the cached response near-instantly.
If you don't want to manage a session object, requests-cache can also be installed globally:
requests_cache.install_cache('demo_cache')
requests.get('http://httpbin.org/delay/1')
Next Steps
To find out more about what you can do with requests-cache, see:
- The User Guide and Advanced Usage sections
- A working example at Real Python: Caching External API Requests
- More examples in the examples/ folder
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file requests-cache-0.7.0.tar.gz.
File metadata
- Download URL: requests-cache-0.7.0.tar.gz
- Upload date:
- Size: 928.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.0a1 CPython/3.9.5 Linux/5.4.0-1051-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b05e8e518c7e80787f98e422653be10621ba02b94bce96780e129f6034c9b890 |
|
| MD5 | 936d07d68d5acbb4e55051c6b438f17b |
|
| BLAKE2b-256 | 6510b5cb742d7b0ab5d297bf85ccbe350badda768c18dda9c9062f48e6f0a984 |
File details
Details for the file requests_cache-0.7.0-py3-none-any.whl.
File metadata
- Download URL: requests_cache-0.7.0-py3-none-any.whl
- Upload date:
- Size: 49.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.0a1 CPython/3.9.5 Linux/5.4.0-1051-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 96bbf1338e9a124c01bfdd6498eccbfab174a807b5951266b0e37d0a1b2fefca |
|
| MD5 | 91b92907fa754a1188dd2d832dee0294 |
|
| BLAKE2b-256 | db041bd25f86b5a0169d02375523382c263db4346a4af66e7187c1b15e6cb73a |
