Skip to content

Commit 4be9f1d

Browse files
authored
doc: Clarify extent of proxying to redis-py (#51)
Closes #50
1 parent f05e0d7 commit 4be9f1d

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,17 @@ def create_app():
4949
return app
5050
```
5151

52+
The `FlaskRedis` client here will pass its keyword arguments
53+
to the [`Redis` class](https://redis-py.readthedocs.io/en/latest/#redis.Redis)
54+
from the [`redis-py`](https://github.com/andymccurdy/redis-py) library,
55+
so all parameters from the `Redis` documentation page will work here as well
56+
— such as `socket_timeout` and `encoding`.
57+
5258
### Accessing Redis
5359

54-
The redis client you created above from `FlaskRedis` acts just like a regular `Redis` instance from the [`redis-py`](https://github.com/andymccurdy/redis-py) library:
60+
Access is done by using `FlaskRedis` as if it was a
61+
[`Redis` class](https://redis-py.readthedocs.io/en/latest/#redis.Redis)
62+
as well:
5563

5664
```python
5765
from my_app import redis_client

0 commit comments

Comments
 (0)