All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
- Reorganized the module and rewrote everything other than the library code, mainly packaging and CI. There are no user-facing changes in behavior.
- Backwards incompatible: The
FlaskRedis.init_app
method no longer takes astrict
parameter. Pass this flag when creating yourFlaskRedis
instance, instead. - Backwards incompatible: The extension will now be registered
under the (lowercased) config prefix of the instance. The default
config prefix is
'REDIS'
, so unless you change that, you can still access the extension viaapp.extensions['redis']
as before. - Backwards incompatible: The default class has been changed to
redis.StrictRedis
. You can switch back to the oldredis.Redis
class by specifyingstrict=False
in theFlaskRedis
kwargs. - You can now pass all supported
Redis
keyword arguments (such asdecode_responses
) toFlaskRedis
and they will be correctly passed over to theredis-py
instance. Thanks, @giyyapan! - Usage like
redis_store['key'] = value
,redis_store['key']
, anddel redis_store['key']
is now supported. Thanks, @ariscn!
- Made 0.1.0's deprecation warned changes final
- Deprecation: Renamed
flask_redis.Redis
toflask_redis.FlaskRedis
. Using the old name still works, but emits a deprecation warning, as it will be removed from the next version - Deprecation: Setting a
REDIS_DATABASE
(or equivalent) now emits a deprecation warning as it will be removed in the version in favor of including the database number inREDIS_URL
(or equivalent) - Added a
FlaskRedis.from_custom_provider(provider)
class method for using any redis provider class that supports instantiation with afrom_url
class method - Added a
strict
parameter toFlaskRedis
which expects a boolean value and allows choosing between usingredis.StrictRedis
andredis.Redis
as the defualt provider. - Made
FlaskRedis
register as a Flask extension through Flask's extension API - Rewrote test suite in py.test
- Got rid of the hacky attribute copying mechanism in favor of using
the
__getattr__
magic method to pass calls to the underlying client
- Improved Python 3 Support (Thanks underyx!).
- Improved test cases.
- Improved configuration.
- Fixed up documentation.
- Removed un-used imports (Thanks underyx and lyschoening!).
- Improved suppot for the config prefix.
- Added support for config_prefix, allowing multiple DBs.
- Added TravisCI Testing for Flask 0.9/0.10.
- Added Badges to README.
- Implemented a very simple test.
- Fixed some documentation issues.
- Included requirements.txt for testing.
- Included task file including some basic methods for tests.
- Conception
- Initial Commit of Package to GitHub.