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 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

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]"

To install all dependencies including development tools:

uv pip install -e ".[dev,mongo,redis,cnamedtuple]"

Project Structure

flowgate/
├── __init__.py
├── command_handler.py    # Command handling functionality
├── consumer.py           # Kafka consumer implementation
├── event_handler.py      # Event handling functionality
├── handler.py            # Base handler implementation
├── helpers/              # Helper utilities
├── message.py            # Message definitions
├── messagebus/           # Message bus implementation
├── serializers.py        # Serialization utilities
└── utils.py              # General utilities

License

MIT