django-valkey is a BSD licensed, full featured Valkey cache and session backend for Django.
this project is a fork of the wonderful django-redis project. they wrote all the good codes.
- Valkey is a free licenced and well maintained key/value database
- Uses native valkey-py url notation connection strings
- async support
- Pluggable clients
- Pluggable parsers
- Pluggable serializers
- Primary/secondary support in the default client
- Comprehensive test suite
- Used in production in several projects as cache and session storage
- Supports infinite timeouts
- Facilities for raw access to Valkey client/connection pool
- Highly configurable (can emulate memcached exception behavior, for example)
- Unix sockets supported by default
- Python 3.10+
- Django 4.2.20+
- Django~=5.0 and Django~=5.1 are not supported, because they are end of life: https://endoflife.date/django
- valkey-py 6.0.2+
- Valkey server 7.2.6+
check out our Docs for a complete explanation
Install with pip:
python -m pip install django-valkeyInstall with c bindings:
python -m pip install django-valkey[libvalkey]Install 3rd party compression
python -m pip install django-valkey[lz4]python -m pip install django-valkey[zstd] # not needed since python 3.14python -m pip install django-valkey[brotli]Install with 3rd party serializers
python -m pip install django-valkey[msgpack]python -m pip install django-valkey[msgspec]contribution rules are like other projects,being respectful and keeping the ethics. also make an issue before going through troubles of coding, someone might already be doing what you want to do.
- Fix the CI in cluster branch.
- Add cluster to documentations.
Copyright (v) 2024 Amirreza Sohrabi far
Copyright (c) 2011-2016 Andrey Antukh <niwi@niwi.nz>
Copyright (c) 2011 Sean Bleier
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS`` AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.