prefect-redis 0.1.4

Prefect integrations for working with Redis

prefect-redis

Welcome!

Prefect integrations for working with Redis

Getting Started

Python setup

Requires an installation of Python 3.7+.

We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.

These tasks are designed to work with Prefect 2.0. For more information about how to use Prefect, please refer to the Prefect documentation.

Installation

Install prefect-redis with pip:

pip install prefect-redis

Then, register to view the block on Prefect Cloud:

prefect block register -m prefect_redis.credentials

Note, to use the load method on Blocks, you must already have a block document saved through code or saved through the UI.

Write and run a flow

from prefect import flow
from prefect_redis import (
    RedisCredentials,
    redis_set,
    redis_get,
)


@flow
def example_flow():
    
    # Load credentials-block
    credentials = RedisCredentials.load("my-redis-store")
    
    # Set a redis-key - Supports any object that is not a live connection
    redis_set(credentials, "mykey", {"foo": "bar"})
    
    # Get a redis key
    val = redis_get(credentials, "mykey")
    
    print(val)

example_flow()

Resources

If you encounter any bugs while using prefect-redis, feel free to open an issue in the prefect-redis repository.

If you have any questions or issues while using prefect-redis, you can find help in either the Prefect Discourse forum or the Prefect Slack community.

Feel free to ⭐️ or watch prefect-redis for updates too!

Development

If you'd like to install a version of prefect-redis for development, clone the repository and perform an editable install with pip:

git clone https://github.com/C4IROcean/prefect-redis.git

cd prefect-redis/

pip install -e ".[dev]"

# Install linting pre-commit hooks
pre-commit install