redis-py dev documentation (original) (raw)

Back to top

Edit this page

Toggle table of contents sidebar

redis-py - Python Client for Redis#

Getting Started#

redis-py requires a running Redis server, and Python 3.7+. See the Redis quickstart for Redis installation instructions.

redis-py can be installed using pip via pip install redis.

Quickly connecting to redis#

There are two quick ways to connect to Redis.

Assuming you run Redis on localhost:6379 (the default)

import redis r = redis.Redis() r.ping()

Running redis on foo.bar.com, port 12345

import redis r = redis.Redis(host='foo.bar.com', port=12345) r.ping()

Another example with foo.bar.com, port 12345

import redis r = redis.from_url('redis://foo.bar.com:12345') r.ping()

After that, you probably want to run redis commands.

Redis Command Functions#

• Redis Commands
  • Core Commands
  • Sentinel Commands
  • Redis Cluster Commands
• Redis Modules Commands
  • RedisBloom Commands
  • RedisGraph Commands
  • RedisJSON Commands
  • RediSearch Commands
  • RedisTimeSeries Commands

Module Documentation#

• Connecting to Redis
• Clustering
• Exceptions
• Backoff
• Lock
• Retry Helpers
• Lua Scripting in default connections
• Pipelines
• Cluster Mode
• Integrating OpenTelemetry
• RESP 3 Features
• Advanced Features
• Examples

Contributing#

• How to contribute
• Issue Tracker
• Source Code
• Release History

License#

This project is licensed under the MIT license.