Skip to content

Commit abd20d4

Browse files
authored
Add references to new DynamoDBCache backend (aio-libs#982)
1 parent 58301fb commit abd20d4

File tree

3 files changed

+19
-6
lines changed

3 files changed

+19
-6
lines changed

README.rst

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
aiocache
22
########
33

4-
Asyncio cache supporting multiple backends (memory, redis and memcached).
4+
Asyncio cache supporting multiple backends (memory, redis, memcached, etc.).
55

66
.. image:: https://codecov.io/gh/aio-libs/aiocache/branch/master/graph/badge.svg
77
:target: https://codecov.io/gh/aio-libs/aiocache
@@ -100,7 +100,7 @@ How does it work
100100

101101
Aiocache provides 3 main entities:
102102

103-
- **backends**: Allow you specify which backend you want to use for your cache. Currently supporting: SimpleMemoryCache, RedisCache using redis_ and MemCache using aiomcache_.
103+
- **backends**: Allow you specify which backend you want to use for your cache. See the docs for a full list of supported backends.
104104
- **serializers**: Serialize and deserialize the data between your code and the backends. This allows you to save any Python object into your cache. Currently supporting: StringSerializer, PickleSerializer, JsonSerializer, and MsgPackSerializer. But you can also build custom ones.
105105
- **plugins**: Implement a hooks system that allows to execute extra behavior before and after of each command.
106106

@@ -141,7 +141,3 @@ Documentation
141141
- `Decorators <http://aiocache.readthedocs.io/en/latest/decorators.html>`_
142142
- `Testing <http://aiocache.readthedocs.io/en/latest/testing.html>`_
143143
- `Examples <https://github.com/argaen/aiocache/tree/master/examples>`_
144-
145-
146-
.. _redis: https://github.com/redis/redis-py
147-
.. _aiomcache: https://github.com/aio-libs/aiomcache

docs/caches.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,19 @@ MemcachedCache
7474

7575
.. autoclass:: aiocache.backends.memcached.MemcachedCache
7676
:members:
77+
78+
79+
.. _dynamodbcache:
80+
81+
Third-party caches
82+
==================
83+
84+
Additional cache backends are available through other libraries.
85+
86+
DynamoDBCache
87+
-------------
88+
89+
`aiocache-dynamodb <https://github.com/vonsteer/aiocache-dynamodb>`_ provides support for DynamoDB.
90+
91+
.. autoclass:: aiocache_dynamodb.DynamoDBCache
92+
:members:

requirements-dev.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ flake8-requirements==2.2.1
88
mypy==1.15.0; implementation_name=="cpython"
99
types-redis==4.6.0.20241004
1010
types-ujson==5.10.0.20250326
11+
aiocache-dynamodb==0.0.3 # used for docs

0 commit comments

Comments
 (0)