summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2021-08-21 19:21:16 -0500
committerJordan Cook <jordan.cook@pioneer.com>2021-08-23 12:35:11 -0500
commit2da93db9a3bd0ed98ff3b4c1dd120fa8da86fd00 (patch)
tree547b1c32e3ea935f6a8ab016e8903e7c32bf17cb
parentc00776b53ca7556b27d64f088ee0f07bce6eabc5 (diff)
downloadrequests-cache-2da93db9a3bd0ed98ff3b4c1dd120fa8da86fd00.tar.gz
Update Readme intro and link another article on examples page
-rw-r--r--HISTORY.md4
-rw-r--r--README.md28
-rw-r--r--docs/examples.md1
3 files changed, 17 insertions, 16 deletions
diff --git a/HISTORY.md b/HISTORY.md
index d431c2d..d82968d 100644
--- a/HISTORY.md
+++ b/HISTORY.md
@@ -12,7 +12,6 @@
**Backends:**
* Filesystem: Add `use_cache_dir` option to use platform-specific user cache directory
* Filesystem: Add `FileCache.paths()` method
-* Filesystem: Fix issue in which `redirects.sqlite` would get included in response paths
* SQLite: Add `use_cache_dir` option to use platform-specific user cache directory
* SQLite: Add `use_memory` option and support for in-memory databases
* SQLite: Add `SQLiteCache.db_path` property
@@ -46,7 +45,8 @@
-----
### 0.7.5 (2021-TBD)
-* Fix incorrect location of `redirects.sqlite` when using filesystem backend
+* Fix incorrect location of `redirects.sqlite` with filesystem backend
+* Fix issue in which `redirects.sqlite` would get included in response paths with filesystem backend
### 0.7.4 (2021-08-16)
* Fix an issue with httpdate strings from `Expires` headers not getting converted to UTC
diff --git a/README.md b/README.md
index 65a7979..08aca92 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
# Requests-Cache
[![Build](https://github.com/reclosedev/requests-cache/actions/workflows/build.yml/badge.svg)](https://github.com/reclosedev/requests-cache/actions/workflows/build.yml)
-[![Coverage](https://coveralls.io/repos/github/reclosedev/requests-cache/badge.svg?branch=master)](https://coveralls.io/github/reclosedev/requests-cache?branch=master)
-[![Documentation](https://img.shields.io/readthedocs/requests-cache/stable)](https://requests-cache.readthedocs.io/en/stable/)
+[![Documentation](https://img.shields.io/readthedocs/requests-cache/stable)](https://requests-cache.readthedocs.io/en/stable/)[![Coverage](https://coveralls.io/repos/github/reclosedev/requests-cache/badge.svg?branch=master)](https://coveralls.io/github/reclosedev/requests-cache?branch=master)
+[![Code Shelter](https://www.codeshelter.co/static/badges/badge-flat.svg)](https://www.codeshelter.co/)
+
[![PyPI](https://img.shields.io/pypi/v/requests-cache?color=blue)](https://pypi.org/project/requests-cache)
[![Conda](https://img.shields.io/conda/vn/conda-forge/requests-cache?color=blue)](https://anaconda.org/conda-forge/requests-cache)
-[![PyPI - Python Versions](https://img.shields.io/pypi/pyversions/requests-cache)](https://pypi.org/project/requests-cache)
[![PyPI - Format](https://img.shields.io/pypi/format/requests-cache?color=blue)](https://pypi.org/project/requests-cache)
-[![Code Shelter](https://www.codeshelter.co/static/badges/badge-flat.svg)](https://www.codeshelter.co/)
+[![PyPI - Python Versions](https://img.shields.io/pypi/pyversions/requests-cache)](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
diff --git a/docs/examples.md b/docs/examples.md
index 0ed67f5..c59c662 100644
--- a/docs/examples.md
+++ b/docs/examples.md
@@ -7,6 +7,7 @@ Some articles and blog posts that discuss requests-cache:
* PyBites: [Module of the Week: requests-cache for repeated API calls](https://pybit.es/articles/requests-cache/)
* Real Python: [Caching External API Requests](https://realpython.com/blog/python/caching-external-api-requests)
* Thomas Gorham: [Faster Backtesting with requests-cache](https://www.mntn.dev/blog/requests-cache)
+* Tim O'Hearn: [Pragmatic Usage of requests-cache](https://www.tjohearn.com/2018/02/12/pragmatic-usage-of-requests-cache/)
* Valdir Stumm Jr: [Tips for boosting your Python scripts](https://stummjr.org/post/building-scripts-in-python/)
## Scripts