diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2021-08-20 16:40:12 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2021-08-20 16:44:59 -0500 |
| commit | 883ccbb96193a0cf153ddbf172b15da316ed46ae (patch) | |
| tree | d2e35c0f9761a36aa8d8276d762f950b12d949b0 /docs/examples.md | |
| parent | b42c644c38daa85b8c0e8747373d45b2b465eccf (diff) | |
| download | requests-cache-883ccbb96193a0cf153ddbf172b15da316ed46ae.tar.gz | |
Link to some articles & blog posts about requests-cache in the Examples section
Diffstat (limited to 'docs/examples.md')
| -rw-r--r-- | docs/examples.md | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/docs/examples.md b/docs/examples.md index 4afbd5c..4e5df65 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,10 +1,19 @@ # Examples This section contains some complete examples that demonstrate the main features of requests-cache. -These can also be found in the +## Articles +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) +* Valdir Stumm Jr: [Tips for boosting your Python scripts](https://stummjr.org/post/building-scripts-in-python/) + +## Scripts +The following scripts can also be found in the [examples/](https://github.com/reclosedev/requests-cache/tree/master/examples) folder on GitHub. -## Basic usage (with sessions) +### Basic usage (with sessions) ```{include} ../examples/basic_usage.py :start-line: 3 :end-line: 4 @@ -17,7 +26,7 @@ These can also be found in the ``` ::: -## Basic usage (with patching) +### Basic usage (with patching) ```{include} ../examples/session_patch.py :start-line: 3 :end-line: 4 @@ -30,7 +39,7 @@ These can also be found in the ``` ::: -## Cache expiration +### Cache expiration ```{include} ../examples/expiration.py :start-line: 2 :end-line: 3 @@ -43,7 +52,7 @@ These can also be found in the ``` ::: -## Logging requests +### Logging requests ```{include} ../examples/log_requests.py :start-line: 2 :end-line: 3 @@ -56,7 +65,7 @@ These can also be found in the ``` ::: -## Cache speed test +### Cache speed test ```{include} ../examples/benchmark.py :start-line: 2 :end-line: 3 @@ -69,7 +78,7 @@ These can also be found in the ``` ::: -## Converting an old cache +### Converting an old cache ```{include} ../examples/convert_cache.py :start-line: 2 :end-line: 4 @@ -83,7 +92,7 @@ These can also be found in the ::: (custom_keys)= -## Custom cache key function +### Custom cache key function ```{include} ../examples/custom_cache_keys.py :start-line: 2 :end-line: 15 |