diff options
| -rw-r--r-- | HISTORY.md | 17 | ||||
| -rw-r--r-- | README.md | 5 | ||||
| -rw-r--r-- | docs/project_info/contributing.md | 2 | ||||
| -rw-r--r-- | docs/project_info/related_projects.md | 14 |
4 files changed, 19 insertions, 19 deletions
@@ -1,6 +1,6 @@ # History -## 0.8.0 (TBD) +## 0.8.0 (2021-TBD) [See all issues and PRs for 0.8](https://github.com/reclosedev/requests-cache/milestone/3?closed=1) **Conditional requests:** @@ -33,19 +33,16 @@ * Note: python 3.6 support in 0.7.x will continue to be maintained until it reaches EOL (2021-12-23) * Any bugfixes for 0.8 that also apply to 0.7 will be backported * Add new `appdirs` dependency (for user cache directories) -* Update `cattrs` from optional to a required dependency -* Update `itsdangerous` required to an optional dependency +* Update `cattrs` from optional to required dependency +* Update `itsdangerous` from required to optional (but recommended) dependency * Require requests 2.22+ and urllib3 1.25.5+ **Deprecations & removals:** * Remove deprecated `core` module -* Remove deprecated `BaseCache.remove_old_entries()` method -* For consistency with other backends, rename: - * `DbCache` -> `SQLiteCache` - * `DbDict` -> `SQLiteDict` - * `DbPickleDict` -> `SQLitePickleDict` - * `DynamoDbCache` -> `DynamoCache` - * `DynamoDbDict` -> `DynamoDict` +* Remove deprecated `BaseCache.remove_old_entries()` method (use `remove_expired_responses()` instead) +* For consistent naming across backends, rename: + * `Db*` -> `SQLiteCache`, `SQLiteDict`, `SQLitePickleDict` + * `DynamoDb*` -> `DynamoCache`, `DynamoDict` * Add aliases for previous names for backwards-compatibility ----- @@ -75,7 +75,7 @@ for i in range(60): With caching, the response will be fetched once, saved to `demo_cache.sqlite`, and subsequent requests will return the cached response near-instantly. -**Patch it:** +**Patching:** If you don't want to manage a session object, or just want to quickly test it out in your application without modifying any code, requests-cache can also be installed globally, and all @@ -88,7 +88,7 @@ requests_cache.install_cache('demo_cache') requests.get('http://httpbin.org/delay/1') ``` -**Customize it:** +**Configuration:** A quick example of some of the options available: ```python @@ -114,6 +114,7 @@ To find out more about what you can do with requests-cache, see: * [User Guide](https://requests-cache.readthedocs.io/en/stable/user_guide.html) * [API Reference](https://requests-cache.readthedocs.io/en/stable/reference.html) +* [Project Info](https://requests-cache.readthedocs.io/en/latest/project_info.html) * A working example at Real Python: [Caching External API Requests](https://realpython.com/blog/python/caching-external-api-requests) * More examples in the diff --git a/docs/project_info/contributing.md b/docs/project_info/contributing.md index bcb858d..5d40716 100644 --- a/docs/project_info/contributing.md +++ b/docs/project_info/contributing.md @@ -8,4 +8,4 @@ :hidden: codeshelter -```
\ No newline at end of file +``` diff --git a/docs/project_info/related_projects.md b/docs/project_info/related_projects.md index 467237f..4773906 100644 --- a/docs/project_info/related_projects.md +++ b/docs/project_info/related_projects.md @@ -12,8 +12,8 @@ You can also check out these other python projects related to caching and/or HTT file-based cache built on SQLite ## Async -* [aiohttp-client-cache](https://github.com/JWCook/aiohttp-client-cache): An async HTTP cache for - `aiohttp`, based on `requests-cache` +* [aiohttp-client-cache](https://github.com/JWCook/aiohttp-client-cache): A client-side async cache + for `aiohttp`, based on `requests-cache` * [aiohttp-cache](https://github.com/cr0hn/aiohttp-cache): A server-side async HTTP cache for the `aiohttp` web server * [aiocache](https://github.com/aio-libs/aiocache): General-purpose (not HTTP-specific) async cache @@ -26,9 +26,11 @@ You can also check out these other python projects related to caching and/or HTT ## Testing * [requests-mock](https://github.com/jamielennox/requests-mock): A `requests` transport adapter that mocks HTTP responses -* [responses](https://github.com/getsentry/responses): A utility for mocking out the `requests` library +* [responses](https://github.com/getsentry/responses): A utility for mocking out the `requests` + library * [vcrpy](https://github.com/kevin1024/vcrpy): Records responses to local files and plays them back - for tests; inspired by Ruby's [VCR](https://github.com/vcr/vcr)]. Works at the `httplib` level and + for tests; inspired by Ruby's [VCR](https://github.com/vcr/vcr). Works at the `httplib` level and is compatible with multiple HTTP libraries. -* [betamax](https://github.com/betamaxpy/betamax): Records responses to local files and plays them back - for tests; also inspired by Ruby's [VCR](https://github.com/vcr/vcr). Made specifically for `requests`. +* [betamax](https://github.com/betamaxpy/betamax): Records responses to local files and plays them + back for tests; also inspired by Ruby's [VCR](https://github.com/vcr/vcr). Made specifically for + `requests`. |