flowgate 0.0.3

Flowgate is a kafka client library for building event-driven systems.

Flowgate

Flowgate is a kafka client library for building event-driven systems.

Setup

Using just (recommended)

First, install just:

# On macOS
brew install just

# On Linux
curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash

Then set up the project:

just setup

Using uv directly

# Install uv if you don't have it
curl -LsSf https://astral.sh/uv/install.sh | sh

# Create a virtual environment and install the package
uv venv .venv
source .venv/bin/activate
uv pip install -e ".[dev]"

Development

Available commands

just                # List all available commands
just setup          # Set up the development environment
just test           # Run tests
just test-ci        # Run tests in CI mode
just lint           # Run linting checks
just build          # Build the package
just publish        # Build and publish the package
just sync           # Sync dependencies
just clean          # Clean up build artifacts

Running tests

just test
# With specific arguments
just test -xvs tests/test_specific.py

Linting

just lint

Building and publishing

just build
just publish

Optional dependencies

Flowgate supports the following optional dependencies:

• MongoDB: uv pip install -e ".[mongo]"
• Redis: uv pip install -e ".[redis]"
• cnamedtuple: uv pip install -e ".[cnamedtuple]"

pip install -e ".[dev]"