Welcome to Django Async Redis’s documentation!

Django Async Redis

https://img.shields.io/pypi/v/django-async-redis.svg https://img.shields.io/travis/Andrew-Chen-Wang/django-async-redis.svg Documentation Status

Introduction

django-async-redis is a full featured Redis cache and session backend for Django.

Requirements

User guide

Installation

Install with pip:

$ python -m pip install django-async-redis

Configure as cache backend

To start using django-async-redis, you should change your Django cache settings to something like:

CACHES = {
    "default": {
        "BACKEND": "django_async_redis.cache.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/1",
        "OPTIONS": {
            "CLIENT_CLASS": "django_async_redis.client.DefaultClient",
        }
    }
}

django-async-redis uses the aioredis native URL notation for connection strings, it allows better interoperability and has a connection string in more “standard” way. Some examples:

  • redis://[:password]@localhost:6379/0
  • rediss://[:password]@localhost:6379/0
  • unix://[:password]@/path/to/socket.sock?db=0

Three URL schemes are supported:

  • redis://: creates a normal TCP socket connection
  • rediss://: creates a SSL wrapped TCP socket connection
  • unix:// creates a Unix Domain Socket connection

There are several ways to specify a database number:

  • A db querystring option, e.g. redis://localhost?db=0
  • If using the redis:// scheme, the path argument of the URL, e.g. redis://localhost/0

In some circumstances the password you should use to connect Redis is not URL-safe, in this case you can escape it or just use the convenience option in OPTIONS dict:

CACHES = {
    "default": {
        "BACKEND": "django_async_redis.cache.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/1",
        "OPTIONS": {
            "CLIENT_CLASS": "django_async_redis.client.DefaultClient",
            "PASSWORD": "mysecret"
        }
    }
}

Take care, that this option does not overwrites the password in the uri, so if you have set the password in the uri, this settings will be ignored.

Notes

Since the majority of this code was ported from django-redis, there was one case that had needed a monkeypatch. In django_async_redis.util, we implement CacheKey which subclasses str which helps us know if a cache key was already created. Since aioredis, checks if the cache key is of type str (and others), I had to monkeypatch that check so that a CacheKey instance could also be accepted.

Credit

  • Hey, I’m Andrew. I’m busy in college, but I wanted to help contribute to Django’s async ecosystem.
  • Lots of code is taken from django-redis, including the tests. I just needed to port everything to asyncio and aioredis.
  • I used cookiecutter-pypackage to generate this project.
  • Thank you to Python Discord server’s async topical chat for helping me understand when to use coroutines over sync functions and @Bast and @hmmmm in general because they’re OG.

Installation

Stable release

To install Django Async Redis, run this command in your terminal:

$ pip install django-async-redis

This is the preferred method to install Django Async Redis, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for Django Async Redis can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/Andrew-Chen-Wang/django-async-redis

Or download the tarball:

$ curl -OJL https://github.com/Andrew-Chen-Wang/django-async-redis/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use Django Async Redis in a project:

import django_async_redis

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/Andrew-Chen-Wang/django_async_redis/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

Django Async Redis could always use more documentation, whether as part of the official Django Async Redis docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/Andrew-Chen-Wang/django_async_redis/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up django_async_redis for local development.

  1. Fork the django_async_redis repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/django_async_redis.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv django_async_redis
$ cd django_async_redis/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ black django_async_redis tests
$ python setup.py test or pytest
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check https://travis-ci.com/Andrew-Chen-Wang/django_async_redis/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ pytest tests.test_django_async_redis

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.1.0 (2020-09-25)

  • First release on PyPI.

Indices and tables