bucket_48/python-django-redis

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-django-redis
   4 VERSION=                5.2.0
   5 KEYWORDS=               python
   6 VARIANTS=               py310 v11
   7 SDESC[py310]=           Redis cache backend for Django (3.10)
   8 SDESC[v11]=             Redis cache backend for Django (3.11)
   9 HOMEPAGE=               https://github.com/jazzband/django-redis
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/75/59/35ac380419a4eafcc30660eaf142cbb334b19922c7250254636e406b8b82
  14 DISTFILE[1]=            django_redis-5.2.0-py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[py310]=           single
  17 SPKGS[v11]=             single
  18
  19 OPTIONS_AVAILABLE=      PY310 PY311
  20 OPTIONS_STANDARD=       none
  21 VOPTS[py310]=           PY310=ON PY311=OFF
  22 VOPTS[v11]=             PY310=OFF PY311=ON
  23
  24 DISTNAME=               django_redis-5.2.0.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY310].RUN_DEPENDS_ON=                 python-Django:single:py310
  29                                         python-redis:single:py310
  30 [PY310].USES_ON=                        python:py310,wheel
  31
  32 [PY311].RUN_DEPENDS_ON=                 python-Django:single:v11
  33                                         python-redis:single:v11
  34 [PY311].USES_ON=                        python:v11,wheel
  35
  36 [FILE:2407:descriptions/desc.single]
  37 ==============================
  38 Redis cache backend for Django
  39 ==============================
  40
  41     :alt: Jazzband
  42
  43    :alt: GitHub Actions
  44
  45    :alt: Coverage
  46
  47 This is a [Jazzband] project. By contributing you agree
  48 to abide by the [Contributor Code of Conduct
  49 ] and follow the [guidelines
  50 ].
  51
  52 Introduction
  53 ------------
  54
  55 django-redis is a BSD licensed, full featured Redis cache and session
  56 backend
  57 for Django.
  58
  59 Why use django-redis?
  60 ~~~~~~~~~~~~~~~~~~~~~
  61
  62 - Uses native redis-py url notation connection strings
  63 - Pluggable clients
  64 - Pluggable parsers
  65 - Pluggable serializers
  66 - Primary/secondary support in the default client
  67 - Comprehensive test suite
  68 - Used in production in several projects as cache and session storage
  69 - Supports infinite timeouts
  70 - Facilities for raw access to Redis client/connection pool
  71 - Highly configurable (can emulate memcached exception behavior, for
  72 example)
  73 - Unix sockets supported by default
  74
  75 Requirements
  76 ~~~~~~~~~~~~
  77
  78 - `Python`_ 3.6+
  79 - `Django`_ 2.2+
  80 - `redis-py`_ 3.0+
  81 - `Redis server`_ 2.8+
  82
  83 .. _Python: https://www.python.org/downloads/
  84 .. _Django: https://www.djangoproject.com/download/
  85 .. _redis-py: https://pypi.org/project/redis/
  86 .. _Redis server: https://redis.io/download
  87
  88 User guide
  89 ----------
  90
  91 Installation
  92 ~~~~~~~~~~~~
  93
  94 Install with pip:
  95
  96 .. code-block:: console
  97
  98     $ python -m pip install django-redis
  99
 100 Configure as cache backend
 101 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 102
 103 To start using django-redis, you should change your Django cache settings
 104 to
 105 something like:
 106
 107 .. code-block:: python
 108
 109     CACHES = {
 110         "default": {
 111             "BACKEND": "django_redis.cache.RedisCache",
 112             "LOCATION": "redis://127.0.0.1:6379/1",
 113             "OPTIONS": {
 114                 "CLIENT_CLASS": "django_redis.client.DefaultClient",
 115             }
 116         }
 117     }
 118
 119 django-redis uses the redis-py native URL notation for connection strings,
 120 it
 121 allows better interoperability and has a connection string in more
 122 "standard"
 123 way. Some examples:
 124
 125 - ``redis://[[username]:[password]]@localhost:6379/0``
 126 - ``rediss://[[username]:[password]]@localhost:6379/0``
 127 - ``unix://[[username]:[password]]@/path/to/socket.sock?db=0``
 128
 129 Three URL schemes are supported:
 130
 131 - ``redis://``: creates a normal TCP socket connection
 132 - ``rediss://``: creates a SSL wrapped TCP socket connection
 133 - ``unix://`` creates a Unix Domain Socket connection
 134
 135 There are several ways to specify a database number:
 136
 137
 138
 139 [FILE:114:distinfo]
 140 1d037dc02b11ad7aa11f655d26dac3fb1af32630f61ef4428860a2e29ff92026        30837 django_redis-5.2.0-py3-none-any.whl
 141