🚀 2fast-handbook

Reference handbook and agent skill base for the 2Fast FastAPI ecosystem.

2fast-handbook is a pure-text package that distributes the base skill and the conventions guides for all 2Fast packages. It does not contain application code; it is the canonical reference for how 2Fast packages are structured, versioned, and documented, and it teaches agents how to work on or with them correctly.

Why

The 2Fast ecosystem (9 packages) repeats the same conventions without a single source of truth, and agents lack a base skill before touching a package. 2fast-handbook provides that single reference: a base skill that handles the majority of packages, plus guides describing the stable structure and rules.

Installation

Install the package to get the skill-base and guides in your environment:

uv pip install 2fast-handbook

The SKILL.md and docs/ are included in the wheel via MANIFEST.in.

Installing the skill in your agent

The skill files live in this package as plain files. Install them however your agent expects — for example, symlink or copy skills/2fast-handbook/SKILL.md into your agent's skill directory, or point your agent at it. Which agent you use is your choice; the files are agent-agnostic.

Package-specific skills

Each complex 2fast package may carry its own specific skill at the canonical path skills/<pkg>/SKILL.md inside its own repository, and include it in its own wheel. The base skill tells the agent how to discover them. If a package-specific skill exists, it takes precedence over this base skill for that package.

Features

• Base skill for the entire 2Fast ecosystem (skills/2fast-handbook/SKILL.md).
• Conventions guides in docs/ (package structure, pyproject, settings, MANIFEST, README, versioning, commits).
• Golden rule: agents may modify 2fast packages locally, never publish to PyPI on their own.
• MIT-licensed and free to fork.

Documentation

See the docs/ folder:

• Package structure
• Naming conventions
• pyproject.toml
• Settings
• MANIFEST.in
• README
• Versioning
• Release
• Commits
• Skills

License

This project is licensed under the MIT License.