summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* Fix typosJordan Cook2023-03-011-5/+5
|
* Introduce cache headers and expiration in ReadmeJordan Cook2023-03-011-2/+35
|
* Related doc updatesJordan Cook2022-06-171-1/+1
|
* Alternate host for requests docsJordan Cook2022-06-111-2/+2
|
* Update repo links, changelog, and contributorsJordan Cook2022-05-151-2/+2
|
* use https for links谭九鼎2022-05-091-4/+4
|
* Update some user docsJordan Cook2022-04-191-17/+14
|
* Use a set_ttl() method instead of keyword argument, since it should only be ↵Jordan Cook2022-04-151-6/+3
| | | | set once (or overwritten)
* Vectorize logo, color it to match light/dark theme colors on rtd, and add ↵Jordan Cook2021-09-181-1/+2
| | | | modified version to Readme
* Switch from coveralls to codecovJordan Cook2021-09-181-1/+2
|
* Remove 'format' badge from Readme and add 'downloads per month' badgeJordan Cook2021-09-141-1/+1
|
* Use sphinx_autodoc_typehints extension instead of autodoc's built-in type hintsJordan Cook2021-09-081-3/+2
|
* Update changelog and Readme linksv0.8.0Jordan Cook2021-09-071-12/+13
|
* Alias/rename old_data_on_error to stale_if_error for consistency with ↵Jordan Cook2021-09-061-2/+2
| | | | Cache-Control: stale-if-error (backwards-compatibile)
* Alias/rename 'include_get_headers' to 'match_headers' for clarity ↵Jordan Cook2021-09-061-1/+1
| | | | (backwards-compatibile)
* Minor edits for Readme and Related ProjectsJordan Cook2021-08-281-2/+3
|
* Add another Quickstart example to briefly introduce some optionsJordan Cook2021-08-281-12/+41
|
* Update Readme intro and link another article on examples pageJordan Cook2021-08-231-14/+14
|
* More info and editing for Readme introJordan Cook2021-08-201-18/+25
|
* Add more detailed installation info and conda-forge badgeJordan Cook2021-08-201-0/+1
|
* Update user guide and ReadmeJordan Cook2021-08-141-11/+18
|
* Remove deprecated 'core' module and BaseCache.remove_old_entries()Jordan Cook2021-08-141-1/+1
|
* Fix a Readme linkJordan Cook2021-07-211-1/+1
|
* Update readthedocs links to point to stable version instead of latestJordan Cook2021-05-081-11/+11
|
* Add a filesystem backendJordan Cook2021-04-211-1/+1
|
* Make Readme more concise again, and split main usage docs into 'Quickstart' ↵Jordan Cook2021-04-031-137/+43
| | | | | | | (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-031-16/+16
| | | | | | | | | | | | | | * 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-2/+2
| | | | 'core' module for backwards-compatibility
* Move 'Security' section to a separate page, link from Readme, and add ↵Jordan Cook2021-03-281-21/+26
| | | | itsdangerous to default package dependencies
* More usage examples, formatting, and editing for Readme + Sphinx docsJordan Cook2021-03-241-28/+115
| | | | | | | | | | | | | * 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-051-0/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* Add some more badges: GitHub Actions, Readthedocs, pypi version, python ↵Jordan Cook2021-03-031-0/+8
| | | | versions, release format
* Add links to some other cache projects; remove link to httpcache since it's ↵Jordan Cook2021-03-031-0/+18
| | | | no longer maintained
* Convert Readme to markdownJordan Cook2021-03-031-0/+34
View Lorry Controller Status