diff options
| author | Roman Haritonov <reclosedev@gmail.com> | 2013-01-13 14:28:16 +0400 |
|---|---|---|
| committer | Roman Haritonov <reclosedev@gmail.com> | 2013-01-13 14:28:16 +0400 |
| commit | a1dd3a3438e84a062594bb68e767b6043e33ebeb (patch) | |
| tree | 5d881854433afbd0e25e93b0b337d4c09bc36c3b /docs/user_guide.rst | |
| parent | f29ba15232d2c8d3caecbb62d4866e0225ad476b (diff) | |
| download | requests-cache-a1dd3a3438e84a062594bb68e767b6043e33ebeb.tar.gz | |
docs
Diffstat (limited to 'docs/user_guide.rst')
| -rw-r--r-- | docs/user_guide.rst | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 5503e4c..08296ac 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -30,7 +30,9 @@ There is two ways of using :mod:`requests_cache`: - Using :class:`CachedSession` instead ``requests.Session`` - Monkey patching ``requests`` to use :class:`CachedSession` by default -Just import :mod:`requests_cache` and call :func:`install_cache` +Monkey-patching allows to add caching to existent program by adding just two lines: + +Import :mod:`requests_cache` and call :func:`install_cache` :: import requests @@ -58,7 +60,7 @@ set to 300 seconds can be configured as:: Transparent caching is achieved by monkey-patching ``requests`` library -It is possible to uninstall this patch with :func:`uninstall_patch`. +It is possible to uninstall this patch with :func:`requests_cache.uninstall_cache() <requests_cache.core.uninstall_cache>`. Also, you can use :func:`requests_cache.disabled() <requests_cache.core.disabled>` context manager for temporary disabling caching:: @@ -129,7 +131,8 @@ List of available backends: but there is some workarounds, see question on `StackOverflow <http://stackoverflow.com/questions/7166998/pymongo-gevent-throw-me-a-banana-and-just-monkey-patch>`_. -You can write your own. See :ref:`cache_backends` API documentation and sources. +You can write your own and pass instance to :func:`install_cache` or :class:`CachedSession` constructor. +See :ref:`cache_backends` API documentation and sources. ---------------------- |
