flash-agents

A template Python library for building agents — powered by uv.

Installation

pip install flash-agents

Or with uv:

uv add flash-agents

Quick Start

from flash_agents import Agent

class MyAgent(Agent):
    def run(self, input: str, **kwargs) -> str:
        return f"Result: {input}"

agent = MyAgent()
print(agent.run("hello"))

Development Setup

# Clone the repo
git clone https://github.com/yourusername/flash-agents.git
cd flash-agents

# Install with dev dependencies using uv
uv sync --all-extras --dev

# Run tests
uv run pytest

# Lint
uv run ruff check .

# Format
uv run ruff format .

# Type check
uv run mypy src/

Project Layout

flash-agents/
├── src/
│   └── flash_agents/
│       ├── __init__.py        # Public API
│       ├── agent.py           # Abstract Agent base class
│       ├── py.typed           # PEP 561 marker
│       └── examples/
│           └── echo_agent.py  # Minimal example
├── tests/
│   └── test_agent.py
├── .github/
│   └── workflows/
│       └── publish.yml        # Auto-publish to PyPI on version tags
├── pyproject.toml
└── README.md

Publishing to PyPI

See PUBLISHING.md for step-by-step upload instructions.

License

MIT