<feed xmlns='http://www.w3.org/2005/Atom'>
<title>delta/python-packages/requests-cache.git/docs/conf.py, branch dev</title>
<subtitle>github.com: reclosedev/requests-cache
</subtitle>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/requests-cache.git/'/>
<entry>
<title>Allow passing any valid backend connection kwargs via BaseCache</title>
<updated>2021-04-19T21:45:34+00:00</updated>
<author>
<name>Jordan Cook</name>
<email>jordan.cook@pioneer.com</email>
</author>
<published>2021-04-19T02:46:08+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/requests-cache.git/commit/?id=f0916900e11778f9ff0a33b148edbf2f51f6f600'/>
<id>f0916900e11778f9ff0a33b148edbf2f51f6f600</id>
<content type='text'>
* 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)
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* 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)
</pre>
</div>
</content>
</entry>
<entry>
<title>Include example scripts on readthedocs</title>
<updated>2021-04-17T02:40:23+00:00</updated>
<author>
<name>Jordan Cook</name>
<email>jordan.cook@pioneer.com</email>
</author>
<published>2021-04-13T18:53:00+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/requests-cache.git/commit/?id=35561110e8f52ad0ab03d40dcc64d88e654aeff5'/>
<id>35561110e8f52ad0ab03d40dcc64d88e654aeff5</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Pin docutils version due to breaking changes, and switch back to sphinx-rtd-theme</title>
<updated>2021-04-05T04:07:00+00:00</updated>
<author>
<name>Jordan Cook</name>
<email>jordan.cook@pioneer.com</email>
</author>
<published>2021-04-05T04:03:37+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/requests-cache.git/commit/?id=319e4c157dc26c79c0fc1e8be0393b8f346d044f'/>
<id>319e4c157dc26c79c0fc1e8be0393b8f346d044f</id>
<content type='text'>
See:
* https://github.com/sphinx-doc/sphinx/issues/9001
* https://github.com/readthedocs/sphinx_rtd_theme/issues/1112
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
See:
* https://github.com/sphinx-doc/sphinx/issues/9001
* https://github.com/readthedocs/sphinx_rtd_theme/issues/1112
</pre>
</div>
</content>
</entry>
<entry>
<title>Switch to sphinx-material theme</title>
<updated>2021-04-04T01:38:43+00:00</updated>
<author>
<name>Jordan Cook</name>
<email>jordan.cook@pioneer.com</email>
</author>
<published>2021-04-04T00:33:06+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/requests-cache.git/commit/?id=0d07fd3cf3bc988766444f22825d962ae9c00b9a'/>
<id>0d07fd3cf3bc988766444f22825d962ae9c00b9a</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Update to Ubuntu 20.04 build image for readthedocs</title>
<updated>2021-04-04T01:38:42+00:00</updated>
<author>
<name>Jordan Cook</name>
<email>jordan.cook@pioneer.com</email>
</author>
<published>2021-04-03T23:54:02+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/requests-cache.git/commit/?id=da64914ae5523856b00bb6bd43331d1524808015'/>
<id>da64914ae5523856b00bb6bd43331d1524808015</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Improvements to Sphinx documentation:</title>
<updated>2021-04-03T20:30:00+00:00</updated>
<author>
<name>Jordan Cook</name>
<email>jordan.cook@pioneer.com</email>
</author>
<published>2021-04-02T19:03:24+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/requests-cache.git/commit/?id=8854ae6982aeca12349536bcecf16eb0a8973c45'/>
<id>8854ae6982aeca12349536bcecf16eb0a8973c45</id>
<content type='text'>
* 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
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* 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
</pre>
</div>
</content>
</entry>
<entry>
<title>Move 'Security' section to a separate page, link from Readme, and add itsdangerous to default package dependencies</title>
<updated>2021-03-28T15:39:40+00:00</updated>
<author>
<name>Jordan Cook</name>
<email>jordan.cook@pioneer.com</email>
</author>
<published>2021-03-25T14:44:31+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/requests-cache.git/commit/?id=2aebfe37e27a4e85c1640a0fe4d1632ba19a6fbf'/>
<id>2aebfe37e27a4e85c1640a0fe4d1632ba19a6fbf</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>More usage examples, formatting, and editing for Readme + Sphinx docs</title>
<updated>2021-03-24T21:46:27+00:00</updated>
<author>
<name>Jordan Cook</name>
<email>jordan.cook@pioneer.com</email>
</author>
<published>2021-03-20T20:19:58+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/requests-cache.git/commit/?id=ab18e06217a8a1902d1859aae6b033f469b2232b'/>
<id>ab18e06217a8a1902d1859aae6b033f469b2232b</id>
<content type='text'>
* 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
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* 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
</pre>
</div>
</content>
</entry>
<entry>
<title>Add individual expire_after per request. (#177)</title>
<updated>2021-03-06T00:29:06+00:00</updated>
<author>
<name>Sebastian Höffner</name>
<email>info@sebastian-hoeffner.de</email>
</author>
<published>2021-03-06T00:29:06+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/requests-cache.git/commit/?id=7632de7c457bebf26b7503c8f7be3693b179b077'/>
<id>7632de7c457bebf26b7503c8f7be3693b179b077</id>
<content type='text'>
* 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</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* 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</pre>
</div>
</content>
</entry>
<entry>
<title>Documentation build improvments:</title>
<updated>2021-03-03T15:54:03+00:00</updated>
<author>
<name>Jordan Cook</name>
<email>jordan.cook@pioneer.com</email>
</author>
<published>2021-03-03T15:51:15+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/requests-cache.git/commit/?id=c25514312bafb89fe86663c0112d478714d1f83e'/>
<id>c25514312bafb89fe86663c0112d478714d1f83e</id>
<content type='text'>
* 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
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* 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
</pre>
</div>
</content>
</entry>
</feed>
