diff options
author | Jordan Cook <jordan.cook@pioneer.com> | 2022-05-15 10:47:37 -0500 |
---|---|---|
committer | Jordan Cook <jordan.cook@pioneer.com> | 2022-05-15 10:58:10 -0500 |
commit | 2ad81ab8f54271ec33ad4ed05db76541f984d608 (patch) | |
tree | 5d626e747b54b44e8089b067fd2f7e949bd6c831 /docs/user_guide | |
parent | fade187eb4c6cd1d16ce375b21f38ddf1aceecdf (diff) | |
download | requests-cache-2ad81ab8f54271ec33ad4ed05db76541f984d608.tar.gz |
Update repo links, changelog, and contributors
Diffstat (limited to 'docs/user_guide')
-rw-r--r-- | docs/user_guide/backends.md | 4 | ||||
-rw-r--r-- | docs/user_guide/backends/dynamodb.md | 2 | ||||
-rw-r--r-- | docs/user_guide/compatibility.md | 2 | ||||
-rw-r--r-- | docs/user_guide/headers.md | 2 | ||||
-rw-r--r-- | docs/user_guide/troubleshooting.md | 10 |
5 files changed, 10 insertions, 10 deletions
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 |