Redis support for Muffin framework.
Project description
Muffin-Redis – Redis support for Muffin framework.
Requirements
python >= 3.7
Installation
Muffin-Redis should be installed using pip:
pip install muffin-redis
To install fakeredis (for testing purposes):
pip install muffin-redis[fake]
Usage
Setup the plugin and connect it into your app:
from muffin import Application
from muffin_redis import Plugin as Redis
# Create Muffin Application
app = Application('example')
# Initialize the plugin
# As alternative: redis = Redis(app, **options)
redis = Redis(address='redis://localhost')
redis.setup(app)
That’s it now you are able to use the plugin inside your views:
@app.route('/some_url', methods=['POST'])
async def some_method(request):
"""Work with redis."""
value = await redis.get('key')
if value is None:
value = ... # Do some work
await redis.set('key', value, expire=60)
return value
For Asyncio the muffin-redis uses aioredis library. So check the library’s docs for futher reference.
Configuration options
Name |
Default value |
Description |
address |
"redis://localhost" |
Redis connection URL |
db |
None |
Number of the Redis DB |
password |
None |
Connection password |
encoding |
"utf-8" |
Connection encoding |
poolsize |
10 |
Connections pool size (set 0 to disable pooling) |
jsonify |
False |
Use json to store/read objects with get/set |
fake |
False |
Use fakeredis. The option is convenient for testing |
Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/muffin-redis/issues
Contributing
Development of Muffin-Redis happens at: https://github.com/klen/muffin-redis
Contributors
klen (Kirill Klenov)
License
Licensed under a MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for muffin_redis-2.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9744872c3c6fe1b648ec51de105c7185f5a55944686951f05c7704956ca8d40d |
|
MD5 | 9daf696afe0df521d929641b40e2fa60 |
|
BLAKE2b-256 | 702d1ef842d83586643f0eebb00843de97f9d218f6f3a6aebabea61487a46168 |