| single |
# redis-py
The Python interface to the Redis key-value store.
[CI]
[docs]
[MIT licensed]
[pypi]
[![pre-release]](https://github.com/redis/redis-py/releases)
[codecov]
[Installation] | [Usage] | [Advanced Topics] | [Contributing]
---------------------------------------------
**Note: ** redis-py 5.0 will be the last version of redis-py to support
Python 3.7, as it has reached [end of life]. redis-py 5.1 will support
Python 3.8+.
---------------------------------------------
## How do I Redis?
[Learn for free at Redis University]
[Build faster with the Redis Launchpad]
[Try the Redis Cloud]
[Dive in developer tutorials]
[Join the Redis community]
[Work at Redis]
## Installation
Start a redis via docker:
``` bash
docker run -p 6379:6379 -it redis/redis-stack:latest
```
To install redis-py, simply:
``` bash
$ pip install redis
```
For faster performance, install redis with hiredis support, this provides a
compiled response parser, and *for most cases* requires zero code changes.
By default, if hiredis >= 1.0 is available, redis-py will attempt to use it
for response parsing.
``` bash
$ pip install "redis[hiredis]"
```
Looking for a high-level library to handle object mapping? See
[redis-om-python]!
## Supported Redis Versions
The most recent version of this library supports redis version [5.0],
[6.0], [6.2], [7.0] and [7.2].
The table below highlights version compatibility of the most-recent library
versions and redis versions.
| Library version | Supported redis versions |
|-----------------|-------------------|
| 3.5.3 | <= 6.2 Family of releases |
| >= 4.5.0 | Version 5.0 to 7.0 |
| >= 5.0.0 | Version 5.0 to current |
## Usage
### Basic Example
``` python
>>> import redis
>>> r = redis.Redis(host='localhost', port=6379, db=0)
>>> r.set('foo', 'bar')
True
>>> r.get('foo')
b'bar'
```
The above code connects to localhost on port 6379, sets a value in Redis,
and retrieves it. All responses are returned as bytes in Python, to receive
decoded strings, set *decode_responses=True*. For this, and more
connection options, see [these examples].
#### RESP3 Support
To enable support for RESP3, ensure you have at least version 5.0 of the
client, and change your connection object to include *protocol=3*
``` python
>>> import redis
>>> r = redis.Redis(host='localhost', port=6379, db=0, protocol=3)
|