summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Add a filesystem backendJordan Cook2021-04-211-0/+2
|
* Allow passing any valid backend connection kwargs via BaseCacheJordan Cook2021-04-191-0/+8
| | | | | | | | * Pass `**kwargs` to backend storage classes, split out any that are valid for the backend-specific connection function/class, and pass them to the connection * Add intersphinx links to docs for dependencies * Update and format some more backend class docstrings * Remove 'Unrecognized keyword arguments' warning from `BaseStorage` * Turn `warnings.warn` about using secret keys into a `logging.warning` (due to complaints about too many messages)
* Include example scripts on readthedocsJordan Cook2021-04-166-0/+122
|
* Remove unused Windows build script for docsJordan Cook2021-04-112-192/+1
|
* Handle errors due to invalid responses in `BaseCache.urls`Jordan Cook2021-04-101-1/+1
|
* Move readthedocs container to a separate docker-compose fileJordan Cook2021-04-101-0/+14
|
* Pin docutils version due to breaking changes, and switch back to ↵Jordan Cook2021-04-044-10/+12
| | | | | | | | sphinx-rtd-theme See: * https://github.com/sphinx-doc/sphinx/issues/9001 * https://github.com/readthedocs/sphinx_rtd_theme/issues/1112
* Add Dockerfile + docker-compose config to make it easier to run the ↵Jordan Cook2021-04-041-0/+5
| | | | readthedocs build container
* Some more documentation updates & editingJordan Cook2021-04-032-13/+35
|
* Switch to sphinx-material themeJordan Cook2021-04-035-14/+12
|
* Update to Ubuntu 20.04 build image for readthedocsJordan Cook2021-04-031-1/+1
|
* Make Readme more concise again, and split main usage docs into 'Quickstart' ↵Jordan Cook2021-04-036-172/+378
| | | | | | | (Readme), 'User Guide', and 'Advanced Usage' sections * Add more details and formatting to changelog * Add some more reference links to classes, methods, and functions mentioned in docs
* Improvements to Sphinx documentation:Jordan Cook2021-04-038-177/+70
| | | | | | | | | | | | | | * Use sphinx-apidoc to auto-generate sources for backend modules * Still manually adding other modules for more control over formatting * Add a couple more contributors I missed * Include contributors on readthedocs * Add 'all' Makefile target and clean auto-generated docs * Remove unused build targets in Makefile * Update interpshinx links that have moved * Fix some interpshinx links * Fix some `:ref:` links using auto-generated labels (and some manually added labels where convenient) * Fix some docstring formatting * Fix remaining build warnings
* Split 'core' module into 'session' and 'patcher' modules; keep placeholder ↵Jordan Cook2021-04-021-8/+9
| | | | 'core' module for backwards-compatibility
* Fix docs for `expire_after_urls` -> `urls_expire_after`Slin Lee2021-03-301-1/+1
|
* Remove some redundant module docstrings, and fix some ref linksJordan Cook2021-03-294-2/+6
|
* Move 'Security' section to a separate page, link from Readme, and add ↵Jordan Cook2021-03-284-42/+55
| | | | itsdangerous to default package dependencies
* More usage examples, formatting, and editing for Readme + Sphinx docsJordan Cook2021-03-247-273/+385
| | | | | | | | | | | | | * Closes #135, #165 * Add a 'Summary' section at the top of the Readme explaining the scope of requests-cache and why you would want to use it * Add some more info explaining the difference between using `CachedSession` directly vs. patching with `install_cache()` * Move basic examples from 'User Guide' section into Readme * Include Readme in Sphinx docs (using `.. mdinclude::`) and remove duplicate sections * Include Contributing guide in Sphinx docs * Convert History doc to markdown and include in Sphinx docs * Use `automod` options to move main cache documentation from `CacheMixin` back to to `CachedSession`, since that's probably where a user will look first * Add more detailed usage examples to an 'Advanced Usage' section for `CachedSession` options (`filter_fn`, `ignore_parameters`, etc.) * Update example scripts and move them to `examples/` folder
* Add individual expire_after per request. (#177)Sebastian Höffner2021-03-053-1/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add individual expire_after per request. This commit adds a new feature to allow individual expire_after times per request. It involves using a custom CachedSession, PerRequestCachedSession, to be used as the session_factory. * Replace deprecated asserts in unit tests Additionally, some sockets are closed even on test failures. This removes some visual clutter when going through the results. * Update docs and README for per-request caching * Remove per_request and integrate behavior into CachedSession * Make test_return_old_data_on_error more reliable This is achieved by using a fixed date and mocking the backend calls to datetime as well. * Adjust per_request cache to new behavior Also adds HTTPBIN_URL environment variable as in test_cache * Add tests for the function determining the expiration datetime * Adjust backend to store expiration dates This also involves slightly different semantics for deletion, but the behavior stays the same. * Minor: black and isort * Update docs for request Add explanation for expire_after special cases, i.e. 'default' and 'cached' and how precedences are handled * Replace assert statements with methods * Remove invalid snippet from README * Remove invalid sentence from docs. * Make expires_before timezone-aware once And combine the checks for expiration * Simplify complexity by removing 'cached' keyword for expire_after
* Refactor CachedSession to be usable as a mixin classJordan Cook2021-03-041-0/+47
|
* Documentation build improvments:Jordan Cook2021-03-031-253/+34
| | | | | | | | | | | | * Add `.readthedocs.yml` build config * Remove mocks for backend modules (pymongo, redis-py, etc.), and make Readthedocs install them before building * Add Sphinx extensions for: * Google-style docstrings * 'Copy' button for code snippets * Automatic type annotation docs * Links to view source code * Add documentation requirements to setup.py for building docs locally * Remove config for unused Sphinx outputs
* Remove all python 2 compatibilityJordan Cook2021-02-261-2/+0
|
* Apply code formatting with black + isortJordan Cook2021-02-261-57/+60
|
* Update hook registration example in docs; closes #127Jordan Cook2021-02-251-1/+1
| | | | Reference: https://2.python-requests.org/en/master/user/advanced/#event-hooks
* Fix namespace on remove_expired_responses exampleJace Browning2018-07-071-1/+1
|
* fix #62 - Update throttle_hook exampleRoman Haritonov2016-03-291-2/+2
|
* #58 docs for ability to force removal of expired entriesRoman Haritonov2015-12-141-1/+23
|
* docs: add note about updating and existing cache. fixes #56Roman Haritonov2015-12-141-0/+6
|
* docs: cleanup docsRoman Haritonov2015-12-142-22/+2
|
* #33 Support for streaming requestsRoman Haritonov2014-12-121-0/+1
|
* Fix #16 Remove note about enabled() context manager from docsRoman Haritonov2013-10-091-1/+0
|
* Mock redis for readthedocs.orgRoman Haritonov2013-04-181-1/+1
|
* Changed docs to reflect availability of redis backendmichaelbeaumont2013-04-172-1/+10
|
* Document backward incompatible changesv1.x.xRoman Haritonov2013-02-242-1/+17
|
* docsRoman Haritonov2013-01-131-3/+6
|
* more doc fixesRoman Haritonov2013-01-132-60/+43
|
* fix API docsRoman Haritonov2013-01-131-2/+2
|
* Rename configure to install_cache and add session_factory parameterRoman Haritonov2013-01-121-9/+9
|
* hash instead url+data, begin fixing redirectsRoman Haritonov2013-01-121-5/+5
|
* v0.2.0v0.2.0Roman Haritonov2013-01-121-1/+1
|
* Change location of changelogRoman Haritonov2013-01-122-36/+0
|
* Document usage of from_cache attributeRoman Haritonov2012-05-101-2/+44
|
* Bump version and add info to changelogv0.1.3Roman Haritonov2012-05-041-22/+30
|
* Small code cleanups and clarification about backends in documentationRoman Haritonov2012-05-041-0/+1
|
* clarify changelogv0.1.2Roman Haritonov2012-05-021-1/+1
|
* bump version, update changelogRoman Haritonov2012-05-021-0/+6
|
* clarify docs about backend optionsRoman Haritonov2012-05-021-0/+4
|
* small typo in docsRoman Haritonov2012-05-021-3/+3
|
* add fast_save option to DbCache backendRoman Haritonov2012-05-021-0/+2
|
* fix minor spelling mistakeDaniel Rech2012-05-021-3/+3
|
View Lorry Controller Status