faery 0.3.0

Ferries event-based data from A to B

Faery sends event data from A to B. It is both a command-line tool and a Python library, wrapping an optimized core written in Rust.

Usage

1. Install pipx (https://pipx.pypa.io/stable/installation/)

2. Install faery

pipx install faery

Local development

Setup the environment

Local build (first run).

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # see https://rustup.rs
python3 -m venv .venv
source .venv/bin/activate
# x86 platforms may need to install https://www.nasm.us
pip install --upgrade pip
pip install maturin
maturin develop  # or maturin develop --release to build with optimizations

Local build (subsequent runs).

source .venv/bin/activate
maturin develop  # or maturin develop --release to build with optimizations

Format and lint

cargo fmt
cargo clippy
pip install isort black pyright
isort .; black .; pyright .

Test

pip install pytest
pytest tests

Upload a new version

1. Update the version in pyproject.toml.

2. Push the changes

3. Create a new release on GitHub. GitHub actions should build wheels and push them to PyPI.

Acknowledgements

Faery was initiated at the 2024 Telluride neuromorphic workshop by

• Alexandre Marcireau
• Jens Egholm Pedersen
• Gregor Lenz
• Gregory Cohen

License: LGPLv3.0