summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2021-05-08 09:14:35 -0500
committerJordan Cook <jordan.cook@pioneer.com>2021-05-08 09:14:35 -0500
commit1575a86d5bde12923e408dfab89cf35745a3f7e8 (patch)
tree997ed7ab42d828ebfdeaafda3082868401a0a105
parent064ec511e9a754b10033d8dd90be8c85b47eb6a3 (diff)
downloadrequests-cache-1575a86d5bde12923e408dfab89cf35745a3f7e8.tar.gz
Update readthedocs links to point to stable version instead of latest
-rw-r--r--CONTRIBUTING.md10
-rw-r--r--HISTORY.md14
-rw-r--r--README.md22
-rw-r--r--examples/README.md2
4 files changed, 27 insertions, 21 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6011389..e3f901f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,12 +1,11 @@
# Contributing Guide
-## Development status
+## Development Status
While the original author no longer has time to work on requests-cache
([see note here](https://github.com/reclosedev/requests-cache/blob/master/CODESHELTER.md)),
one or more maintainers are available via [Code Shelter](https://www.codeshelter.co) to help keep
this project going.
-Maintenance will mainly focus on bugfixes, security and compatibility updates, etc.
If there is a new feature you would like to see, the best way to make that happen is to submit a PR
for it!
@@ -19,6 +18,13 @@ If you want to discuss ideas about the project in general, or if you have an iss
received a response in a timely manner, please reach out on the Code Shelter chat server, under
[projects/requests-cache](https://codeshelter.zulipchat.com/#narrow/stream/186993-projects/topic/requests-cache).
+## Pre-release Installation
+If you want to test out the latest in-development changes, you can install pre-release versions:
+```bash
+pip install --pre requests-cache
+```
+Pre-release documentation can be found here: https://requests-cache.readthedocs.io/en/latest/
+
## Dev Installation
To set up for local development:
diff --git a/HISTORY.md b/HISTORY.md
index 276f064..56bda44 100644
--- a/HISTORY.md
+++ b/HISTORY.md
@@ -62,7 +62,7 @@
[See all issues and PRs for 0.6](https://github.com/reclosedev/requests-cache/milestone/1?closed=1)
Thanks to [Code Shelter](https://www.codeshelter.co) and
-[contributors](https://requests-cache.readthedocs.io/en/latest/contributors.html)
+[contributors](https://requests-cache.readthedocs.io/en/stable/contributors.html)
for making this release possible!
### Serialization
@@ -114,17 +114,17 @@ next time they are requested. They can also be manually converted or removed, if
### General
* Drop support for python <= 3.5
* Add `CacheMixin` class to make the features of `CachedSession` usable as a mixin class,
- for [compatibility with other requests-based libraries](https://requests-cache.readthedocs.io/en/latest/advanced_usage.html#library-compatibility).
+ for [compatibility with other requests-based libraries](https://requests-cache.readthedocs.io/en/stable/advanced_usage.html#library-compatibility).
* Add `HEAD` to default `allowable_methods`
### Docs & Tests
* Add type annotations to main functions/methods in public API, and include in documentation on
- [readthedocs](https://requests-cache.readthedocs.io/en/latest/)
-* Add [Contributing Guide](https://requests-cache.readthedocs.io/en/latest/contributing.html),
- [Security](https://requests-cache.readthedocs.io/en/latest/security.html) info,
+ [readthedocs](https://requests-cache.readthedocs.io/en/stable/)
+* Add [Contributing Guide](https://requests-cache.readthedocs.io/en/stable/contributing.html),
+ [Security](https://requests-cache.readthedocs.io/en/stable/security.html) info,
and more examples & detailed usage info in
- [User Guide](https://requests-cache.readthedocs.io/en/latest/user_guide.html) and
- [Advanced Usage](https://requests-cache.readthedocs.io/en/latest/advanced_usage.html) sections.
+ [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.
* Increase test coverage and rewrite most tests using pytest
* Add containerized backends for both local and CI integration testing
diff --git a/README.md b/README.md
index 494f90b..5e8398c 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# 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/latest)](https://requests-cache.readthedocs.io/en/latest/)
+[![Documentation](https://img.shields.io/readthedocs/requests-cache/stable)](https://requests-cache.readthedocs.io/en/stable/)
[![PyPI](https://img.shields.io/pypi/v/requests-cache?color=blue)](https://pypi.org/project/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)
@@ -16,17 +16,17 @@ 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](https://requests-cache.readthedocs.io/en/latest/api.html#sessions)
- for `requests.Session`, or [install globally](https://requests-cache.readthedocs.io/en/latest/user_guide.html#patching)
+* **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
- [expiration](https://requests-cache.readthedocs.io/en/latest/user_guide.html#cache-expiration)
- and other [behavior](https://requests-cache.readthedocs.io/en/latest/user_guide.html#cache-options)
-* **Persistence:** Includes several [storage backends](https://requests-cache.readthedocs.io/en/latest/user_guide.html#cache-backends):
+ [expiration](https://requests-cache.readthedocs.io/en/stable/user_guide.html#cache-expiration)
+ and other [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, and filesystem.
* **Compatibility:** Can be used alongside
- [other popular libraries based on requests](https://requests-cache.readthedocs.io/en/latest/advanced_usage.html#library-compatibility)
+ [other popular libraries based on requests](https://requests-cache.readthedocs.io/en/stable/advanced_usage.html#library-compatibility)
# Quickstart
First, install with pip:
@@ -34,7 +34,7 @@ First, install with pip:
pip install requests-cache
```
-Next, use [requests_cache.CachedSession](https://requests-cache.readthedocs.io/en/latest/api.html#sessions)
+Next, use [requests_cache.CachedSession](https://requests-cache.readthedocs.io/en/stable/api.html#sessions)
to send and cache requests. To quickly demonstrate how to use it:
**This takes ~1 minute:**
@@ -69,9 +69,9 @@ requests.get('http://httpbin.org/delay/1')
To find out more about what you can do with requests-cache, see:
* The
- [User Guide](https://requests-cache.readthedocs.io/en/latest/user_guide.html) and
- [Advanced Usage](https://requests-cache.readthedocs.io/en/latest/advanced_usage.html) sections
+ [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
+ [examples/](https://requests-cache.readthedocs.io/en/stable/index.html) folder
diff --git a/examples/README.md b/examples/README.md
index 0102fd8..09b35e7 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -1,3 +1,3 @@
# Requests-Cache Examples
This folder contains some complete examples that demonstrate the main features of requests-cache.
-These are also viewable on [readthedocs](https://requests-cache.readthedocs.io/en/latest/examples.html).
+These are also viewable on [readthedocs](https://requests-cache.readthedocs.io/en/stable/examples.html).