1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
# Requests-Cache
[](https://github.com/reclosedev/requests-cache/actions/workflows/build.yml)
[](https://coveralls.io/github/reclosedev/requests-cache?branch=master)
[](https://requests-cache.readthedocs.io/en/stable/)
[](https://pypi.org/project/requests-cache)
[](https://anaconda.org/conda-forge/requests-cache)
[](https://pypi.org/project/requests-cache)
[](https://pypi.org/project/requests-cache)
[](https://www.codeshelter.co/)
## Summary
**requests-cache** is a transparent, persistent cache for the python [requests](http://python-requests.org)
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.
Complete project documentation can be found at [requests-cache.readthedocs.io](https://requests-cache.readthedocs.io).
## Features
* **Ease of use:** Use as a [drop-in replacement](https://requests-cache.readthedocs.io/en/stable/api.html#sessions)
for `requests.Session`, or [install globally](https://requests-cache.readthedocs.io/en/stable/user_guide.html#patching)
to add caching to all `requests` functions
* **Customization:** Works out of the box with zero config, but with plenty of options available for
customizing [cache behavior](https://requests-cache.readthedocs.io/en/stable/user_guide.html#cache-options)
* **Persistence:** Includes several [storage backends](https://requests-cache.readthedocs.io/en/stable/user_guide.html#cache-backends):
SQLite, Redis, MongoDB, GridFS, DynamoDB. Also includes a file-based backend and multiple
[serializers](https://requests-cache.readthedocs.io/en/stable/user_guide.html#serializers), so you
can store responses as plain JSON files, YAML, and more.
* **Expiration:** Use [cache headers](https://requests-cache.readthedocs.io/en/stable/user_guide.html#cache-headers),
aggressively cache everything for long-term use, use [URL patterns](https://requests-cache.readthedocs.io/en/stable/user_guide.html#url-patterns) for selective caching, or anything in between.
* **Compatibility:** Can be combined with
[other popular libraries based on requests](https://requests-cache.readthedocs.io/en/stable/advanced_usage.html#library-compatibility)
# Quickstart
First, install with pip:
```bash
pip install requests-cache
```
Then, use [requests_cache.CachedSession](https://requests-cache.readthedocs.io/en/stable/api.html#sessions)
to make your requests. It behaves like a normal
[requests.Session](https://docs.python-requests.org/en/master/user/advanced/#session-objects),
but with caching behavior.
To illustrate, we'll call an endpoint that adds a delay of 1 second, simulating a slow or
rate-limited website.
**This takes ~1 minute:**
```python
import requests
session = requests.Session()
for i in range(60):
session.get('http://httpbin.org/delay/1')
```
**This takes ~1 second:**
```python
import requests_cache
session = requests_cache.CachedSession('demo_cache')
for i in range(60):
session.get('http://httpbin.org/delay/1')
```
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, or just want to quickly test it out in your application
without modifying any code, requests-cache can also be installed globally:
```python
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](https://requests-cache.readthedocs.io/en/stable/user_guide.html) and
[Advanced Usage](https://requests-cache.readthedocs.io/en/stable/advanced_usage.html) sections
* A working example at Real Python:
[Caching External API Requests](https://realpython.com/blog/python/caching-external-api-requests)
* More examples in the
[examples/](https://github.com/reclosedev/requests-cache/tree/master/examples) folder
|
