Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Redis Extension for PyApp

Project description

Let us handle the boring stuff!

https://img.shields.io/badge/code%20style-black-000000.svg

This extension provides a Redis client factory to allow configuration to be configured via pyApp settings.

The extension also provides checks to confirm the settings are correct and that the application is able to connect to the redis instance.

It is strongly recommended to install the hiredis companion package to improve the performance of the redis client.

Installation

Install using pip:

pip install pyapp-redis

Install using pipenv:

pipenv install pyapp-redis

Add the REDIS block into your runtime settings file:

REDIS = {
    "default": {
        "url": "redis://user:pass@host:port/1",
    },
}

Note

The URL is a defined by Redis client see the documentation. In addition to the url any argument that can be provided to Redis.from_url can be provided.

Usage

The following example creates a Redis client instance:

from pyapp_ext.redis import get_client

# Get connection
redis = get_client()

redis.set("foo")

API

pyapp_ext.redis.get_client(default: str = None) -> Redis

Get named Redis client instance

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyApp-Redis, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size pyApp_Redis-1.0-py3-none-any.whl (6.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pyApp-Redis-1.0.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page