summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2022-05-15 10:47:37 -0500
committerJordan Cook <jordan.cook@pioneer.com>2022-05-15 10:58:10 -0500
commit2ad81ab8f54271ec33ad4ed05db76541f984d608 (patch)
tree5d626e747b54b44e8089b067fd2f7e949bd6c831 /docs
parentfade187eb4c6cd1d16ce375b21f38ddf1aceecdf (diff)
downloadrequests-cache-2ad81ab8f54271ec33ad4ed05db76541f984d608.tar.gz
Update repo links, changelog, and contributors
Diffstat (limited to 'docs')
-rw-r--r--docs/_static/requests-cache-gh-preview.pngbin0 -> 49524 bytes
-rw-r--r--docs/_static/requests-cache-icon.pngbin0 -> 30478 bytes
-rw-r--r--docs/examples.md26
-rw-r--r--docs/user_guide/backends.md4
-rw-r--r--docs/user_guide/backends/dynamodb.md2
-rw-r--r--docs/user_guide/compatibility.md2
-rw-r--r--docs/user_guide/headers.md2
-rw-r--r--docs/user_guide/troubleshooting.md10
8 files changed, 23 insertions, 23 deletions
diff --git a/docs/_static/requests-cache-gh-preview.png b/docs/_static/requests-cache-gh-preview.png
new file mode 100644
index 0000000..3f250fd
--- /dev/null
+++ b/docs/_static/requests-cache-gh-preview.png
Binary files differ
diff --git a/docs/_static/requests-cache-icon.png b/docs/_static/requests-cache-icon.png
new file mode 100644
index 0000000..b91e408
--- /dev/null
+++ b/docs/_static/requests-cache-icon.png
Binary files differ
diff --git a/docs/examples.md b/docs/examples.md
index 367581a..37e4dfc 100644
--- a/docs/examples.md
+++ b/docs/examples.md
@@ -20,7 +20,7 @@ TODO: It might be nice to have a custom extension to do this automatically.
-->
## Scripts
The following scripts can also be found in the
-[examples/](https://github.com/reclosedev/requests-cache/tree/master/examples) folder on GitHub.
+[examples/](https://github.com/requests-cache/requests-cache/tree/main/examples) folder on GitHub.
### Basic usage (with sessions)
```{include} ../examples/basic_sessions.py
@@ -28,7 +28,7 @@ The following scripts can also be found in the
:end-line: 4
```
-:::{admonition} Example: [basic_sessions.py](https://github.com/reclosedev/requests-cache/blob/master/examples/basic_sessions.py)
+:::{admonition} Example: [basic_sessions.py](https://github.com/requests-cache/requests-cache/blob/main/examples/basic_sessions.py)
:class: toggle
```{literalinclude} ../examples/basic_sessions.py
:lines: 6-
@@ -41,7 +41,7 @@ The following scripts can also be found in the
:end-line: 4
```
-:::{admonition} Example: [basic_patching.py](https://github.com/reclosedev/requests-cache/blob/master/examples/basic_patching.py)
+:::{admonition} Example: [basic_patching.py](https://github.com/requests-cache/requests-cache/blob/main/examples/basic_patching.py)
:class: toggle
```{literalinclude} ../examples/basic_patching.py
:lines: 6-
@@ -54,7 +54,7 @@ The following scripts can also be found in the
:end-line: 3
```
-:::{admonition} Example: [expiration.py](https://github.com/reclosedev/requests-cache/blob/master/examples/expiration.py)
+:::{admonition} Example: [expiration.py](https://github.com/requests-cache/requests-cache/blob/main/examples/expiration.py)
:class: toggle
```{literalinclude} ../examples/expiration.py
:lines: 5-
@@ -67,7 +67,7 @@ The following scripts can also be found in the
:end-line: 4
```
-:::{admonition} Example: [url_patterns.py](https://github.com/reclosedev/requests-cache/blob/master/examples/url_patterns.py)
+:::{admonition} Example: [url_patterns.py](https://github.com/requests-cache/requests-cache/blob/main/examples/url_patterns.py)
:class: toggle
```{literalinclude} ../examples/url_patterns.py
:lines: 6-
@@ -80,7 +80,7 @@ The following scripts can also be found in the
:end-line: 4
```
-:::{admonition} Example: [threads.py](https://github.com/reclosedev/requests-cache/blob/master/examples/threads.py)
+:::{admonition} Example: [threads.py](https://github.com/requests-cache/requests-cache/blob/main/examples/threads.py)
:class: toggle
```{literalinclude} ../examples/threads.py
:lines: 6-
@@ -93,7 +93,7 @@ The following scripts can also be found in the
:end-line: 3
```
-:::{admonition} Example: [log_requests.py](https://github.com/reclosedev/requests-cache/blob/master/examples/log_requests.py)
+:::{admonition} Example: [log_requests.py](https://github.com/requests-cache/requests-cache/blob/main/examples/log_requests.py)
:class: toggle
```{literalinclude} ../examples/log_requests.py
:lines: 5-
@@ -106,7 +106,7 @@ The following scripts can also be found in the
:end-line: 8
```
-:::{admonition} Example: [external_config.py](https://github.com/reclosedev/requests-cache/blob/master/examples/external_config.py)
+:::{admonition} Example: [external_config.py](https://github.com/requests-cache/requests-cache/blob/main/examples/external_config.py)
:class: toggle
```{literalinclude} ../examples/external_config.py
:lines: 10-
@@ -119,7 +119,7 @@ The following scripts can also be found in the
:end-line: 8
```
-:::{admonition} Example: [benchmark.py](https://github.com/reclosedev/requests-cache/blob/master/examples/benchmark.py)
+:::{admonition} Example: [benchmark.py](https://github.com/requests-cache/requests-cache/blob/main/examples/benchmark.py)
:class: toggle
```{literalinclude} ../examples/benchmark.py
:lines: 10-
@@ -132,7 +132,7 @@ The following scripts can also be found in the
:end-line: 4
```
-:::{admonition} Example: [convert_cache.py](https://github.com/reclosedev/requests-cache/blob/master/examples/convert_cache.py)
+:::{admonition} Example: [convert_cache.py](https://github.com/requests-cache/requests-cache/blob/main/examples/convert_cache.py)
:class: toggle
```{literalinclude} ../examples/convert_cache.py
:lines: 6-
@@ -146,7 +146,7 @@ The following scripts can also be found in the
:end-line: 15
```
-:::{admonition} Example: [custom_request_matcher.py](https://github.com/reclosedev/requests-cache/blob/master/examples/custom_request_matcher.py)
+:::{admonition} Example: [custom_request_matcher.py](https://github.com/requests-cache/requests-cache/blob/main/examples/custom_request_matcher.py)
:class: toggle
```{literalinclude} ../examples/custom_request_matcher.py
:lines: 17-
@@ -160,7 +160,7 @@ The following scripts can also be found in the
:end-line: 4
```
-:::{admonition} Example: [time_machine_backtesting.py](https://github.com/reclosedev/requests-cache/blob/master/examples/time_machine_backtesting.py)
+:::{admonition} Example: [time_machine_backtesting.py](https://github.com/requests-cache/requests-cache/blob/main/examples/time_machine_backtesting.py)
:class: toggle
```{literalinclude} ../examples/time_machine_backtesting.py
:lines: 6-
@@ -174,7 +174,7 @@ The following scripts can also be found in the
:end-line: 5
```
-:::{admonition} Example: [vcr.py](https://github.com/reclosedev/requests-cache/blob/master/examples/vcr.py)
+:::{admonition} Example: [vcr.py](https://github.com/requests-cache/requests-cache/blob/main/examples/vcr.py)
:class: toggle
```{literalinclude} ../examples/vcr.py
:lines: 7-
diff --git a/docs/user_guide/backends.md b/docs/user_guide/backends.md
index fa27ae9..76a6c50 100644
--- a/docs/user_guide/backends.md
+++ b/docs/user_guide/backends.md
@@ -78,14 +78,14 @@ First, [install docker](https://docs.docker.com/get-docker/) if you haven't alre
:::{tab} Bash (Linux/macOS)
```bash
pip install -U requests-cache[all] docker-compose
-curl https://raw.githubusercontent.com/reclosedev/requests-cache/master/docker-compose.yml -O docker-compose.yml
+curl https://raw.githubusercontent.com/requests-cache/requests-cache/main/docker-compose.yml -O docker-compose.yml
docker-compose up -d
```
:::
:::{tab} Powershell (Windows)
```ps1
pip install -U requests-cache[all] docker-compose
-Invoke-WebRequest -Uri https://raw.githubusercontent.com/reclosedev/requests-cache/master/docker-compose.yml -Outfile docker-compose.yml
+Invoke-WebRequest -Uri https://raw.githubusercontent.com/requests-cache/requests-cache/main/docker-compose.yml -Outfile docker-compose.yml
docker-compose up -d
```
:::
diff --git a/docs/user_guide/backends/dynamodb.md b/docs/user_guide/backends/dynamodb.md
index 0758c1c..ee06aca 100644
--- a/docs/user_guide/backends/dynamodb.md
+++ b/docs/user_guide/backends/dynamodb.md
@@ -96,7 +96,7 @@ Here are the details you will need:
- Range key (aka sort key): `key`
### Example CloudFormation Template
-:::{admonition} Example: [cloudformation.yml](https://github.com/reclosedev/requests-cache/blob/master/examples/cloudformation.yml)
+:::{admonition} Example: [cloudformation.yml](https://github.com/requests-cache/requests-cache/blob/main/examples/cloudformation.yml)
:class: toggle
```{literalinclude} ../../../examples/cloudformation.yml
:language: yaml
diff --git a/docs/user_guide/compatibility.md b/docs/user_guide/compatibility.md
index f50e1b0..510530b 100644
--- a/docs/user_guide/compatibility.md
+++ b/docs/user_guide/compatibility.md
@@ -51,7 +51,7 @@ support wrapping an existing session object:
In this case, `FutureSession` must wrap `CachedSession` rather than the other way around, since
`FutureSession` returns (as you might expect) futures rather than response objects.
-See [issue #135](https://github.com/reclosedev/requests-cache/issues/135) for more notes on this.
+See [issue #135](https://github.com/requests-cache/requests-cache/issues/135) for more notes on this.
## Requests-OAuthlib
Usage with [requests-oauthlib](https://github.com/requests/requests-oauthlib) is the same as other
diff --git a/docs/user_guide/headers.md b/docs/user_guide/headers.md
index 3b3e8e9..7944352 100644
--- a/docs/user_guide/headers.md
+++ b/docs/user_guide/headers.md
@@ -15,7 +15,7 @@ Here's an example using the [GitHub API](https://docs.github.com/en/rest) to get
requests-cache repo:
```python
>>> # Cache a response that will expire immediately
->>> url = 'https://api.github.com/repos/reclosedev/requests-cache'
+>>> url = 'https://api.github.com/repos/requests-cache/requests-cache'
>>> session = CachedSession(expire_after=1)
>>> session.get(url)
>>> time.sleep(1)
diff --git a/docs/user_guide/troubleshooting.md b/docs/user_guide/troubleshooting.md
index ac63afd..fc5154f 100644
--- a/docs/user_guide/troubleshooting.md
+++ b/docs/user_guide/troubleshooting.md
@@ -4,7 +4,7 @@ Here are a few tips for avoiding and debugging some common problems.
## General Tips
* Make sure you're using the latest version: `pip install -U requests-cache`
-* Try [searching issues](https://github.com/reclosedev/requests-cache/issues?q=is%3Aissue+label%3Abug)
+* Try [searching issues](https://github.com/requests-cache/requests-cache/issues?q=is%3Aissue+label%3Abug)
for similar problems
* Enable debug logging to get more information
* If you have a problem and [figure it out yourself](https://xkcd.com/979/), it's likely that
@@ -52,8 +52,8 @@ logging.getLogger('requests_cache').setLevel('DEBUG')
with {py:meth}`CachedSession.cache.clear() <.BaseCache.clear>`.
* **Library updates:** New releases of `requests`, `urllib3` or `requests-cache` itself can
potentially change response data, and be incompatible with previously cached responses. See issues
- [#56](https://github.com/reclosedev/requests-cache/issues/56) and
- [#102](https://github.com/reclosedev/requests-cache/issues/102).
+ [#56](https://github.com/requests-cache/requests-cache/issues/56) and
+ [#102](https://github.com/requests-cache/requests-cache/issues/102).
```{note}
A cached response that can't be reused will simply be deleted and fetched again. If you get a
traceback just by reading from the cache, this is **not** intended behavior, so please create a bug
@@ -93,7 +93,7 @@ Here are some error messages you may see either in the logs or (more rarely) in
round-trips required for consecutive requests. For more details, see the following issues:
* [requests/#3912: ResourceWarning: unclosed socket.socket when I run a unittest?](https://github.com/psf/requests/issues/3912)
* [requests/#2963: ResourceWarning still triggered when warnings enabled](https://github.com/psf/requests/issues/2963#issuecomment-169631513)
- * [requests-cache/#413](https://github.com/reclosedev/requests-cache/issues/413)
+ * [requests-cache/#413](https://github.com/requests-cache/requests-cache/issues/413)
* If needed, this warning can be suppressed with:
```python
import warnings
@@ -104,7 +104,7 @@ Here are some error messages you may see either in the logs or (more rarely) in
## Bug Reports
If you believe you've found a bug, or if you're just having trouble getting requests-cache to work
the way you want, please
-[create an issue](https://github.com/reclosedev/requests-cache/issues/new/choose) for it on GitHub.
+[create an issue](https://github.com/requests-cache/requests-cache/issues/new/choose) for it on GitHub.
Details that will help your issue get resolved:
* A complete example to reproduce the issue