Skip to main content

Avro codec and schema registry support for Faust

Project description

Maintainability

Test Coverage

Faust Avro

Avro codec and schema registry support for Faust.

Getting Started

First Time Setup

  • Get asdf
  • Install python: asdf install python
  • Get poetry
    • curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python
    • As with any code asking you to do this from the internet, you should really first download get-poetry.py and inspect it to make sure it doesn't do anything bad, then run the copy you inspected.
    • Or you can just pip install poetry to stick it inside the main python install by asdf. If you switch python versions and get errors about reshimming poetry, that version of python doesn't have poetry installed.

Install needed packages

poetry install

Activate environment

Most directions here assume you have the poetry-created virtualenv active. Some form of source .venv/bin/activate (or source .venv/bin/activate.(csh|fish)) should activate the environment for you, or you can configure your shell to auto-activate, eg:

$ cat ~/.config/fish/functions/cd.fish
#!/bin/env fish

function cd -d "change directory, and activate virtualenvs, if available"
    # first and foremost, change directory
    builtin cd $argv

    # find a parent git directory
    if git rev-parse --show-toplevel >/dev/null ^/dev/null
        set gitdir (realpath (git rev-parse --show-toplevel))
    else
        set gitdir ""
    end

    # if that directory contains a virtualenv in a ".venv" directory, activate it
    if test \( -z "$VIRTUAL_ENV" -o "$VIRTUAL_ENV" != "$gitdir/.venv" \) -a -f "$gitdir/.venv/bin/activate.fish"
        source $gitdir/.venv/bin/activate.fish
    end

    # deactivate an active virtualenv if not int a git directory with an ".venv"
    if test -n "$VIRTUAL_ENV" -a "$VIRTUAL_ENV" != "$gitdir/.venv"
        deactivate
    end
end

Add pre-commit hooks

Install git pre-commit hooks via pre-commit install. These will auto-run black and isort to ensure your code is pretty no matter what editor you use. This must be done inside an activated environment.

Running tests

pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

faust_avro-0.4.1.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

faust_avro-0.4.1-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file faust_avro-0.4.1.tar.gz.

File metadata

  • Download URL: faust_avro-0.4.1.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0b5 CPython/3.8.5 Linux/5.3.0-1035-azure

File hashes

Hashes for faust_avro-0.4.1.tar.gz
Algorithm Hash digest
SHA256 9380a31178b8bac3d543826d44b02a82c0a8a05be8d1dbbf8f26e6700e1de0f1
MD5 6d99bb6c51590954af21ecae9ef348e3
BLAKE2b-256 09293213b9b90d3a0f42f1ba8821396e6862f05c4c5e78e4166c25af0226d8d2

See more details on using hashes here.

File details

Details for the file faust_avro-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: faust_avro-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0b5 CPython/3.8.5 Linux/5.3.0-1035-azure

File hashes

Hashes for faust_avro-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4a45e59c365eb335268f5724ce9c3476ee0d27047af948453ab79ad73480ace1
MD5 50071a9139be5290a1b0c1f96d79d3dc
BLAKE2b-256 66c28e333ab7a15292c223c3efdb8942d58b4ba5202d8d69c738c031a4b119ea

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page