diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2021-08-21 19:21:16 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2021-08-23 12:35:11 -0500 |
| commit | 2da93db9a3bd0ed98ff3b4c1dd120fa8da86fd00 (patch) | |
| tree | 547b1c32e3ea935f6a8ab016e8903e7c32bf17cb /README.md | |
| parent | c00776b53ca7556b27d64f088ee0f07bce6eabc5 (diff) | |
| download | requests-cache-2da93db9a3bd0ed98ff3b4c1dd120fa8da86fd00.tar.gz | |
Update Readme intro and link another article on examples page
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 14 insertions, 14 deletions
@@ -1,12 +1,12 @@ # 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://requests-cache.readthedocs.io/en/stable/)[](https://coveralls.io/github/reclosedev/requests-cache?branch=master) +[](https://www.codeshelter.co/) + [](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/) +[](https://pypi.org/project/requests-cache) ## Summary **requests-cache** is a transparent, persistent cache for the python [requests](http://python-requests.org) @@ -18,20 +18,20 @@ Complete project documentation can be found at [requests-cache.readthedocs.io](h <!-- END-RTD-IGNORE --> ## Features -* 🍰 **Ease of use:** Use as a [drop-in replacement](https://requests-cache.readthedocs.io/en/stable/api.html#sessions) +* 🍰 **Ease of use:** Keep using the `requests` library you're already familiar with. Add caching + with 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 robust customization and - extensibility so you can tailor it to your needs -* 🚀 **Performance:** With default settings, get sub-millisecond response times for cached responses + to add caching to all `requests` functions. +* 🚀 **Performance:** Get sub-millisecond response times for cached responses * 💾 **Persistence:** Works with several [storage backends](https://requests-cache.readthedocs.io/en/stable/user_guide.html#cache-backends), - including SQLite, Redis, MongoDB, and DynamoDB; also includes - [serializers](https://requests-cache.readthedocs.io/en/stable/user_guide.html#serializers) - for storing responses as plain JSON files, YAML, and more + including SQLite, Redis, MongoDB, and DynamoDB; or save responses as plain JSON files, YAML, + and more +* ⚙️ **Customization:** Works out of the box with zero config, but with a robust set of features for + tweaking and extending the library to suit your needs * 🕗 **Expiration:** Keep your cache fresh using - [HTTP cache headers](https://requests-cache.readthedocs.io/en/stable/user_guide.html#cache-headers), - eagerly cache everything for long-term use, use + [Cache-Control](https://requests-cache.readthedocs.io/en/stable/user_guide.html#cache-headers), + eagerly cache everything for long-term storage, 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 |