Metadata-Version: 2.4
Name: 2fast-handbook
Version: 0.1.2
Summary: Reference handbook and agent skill base for the 2Fast FastAPI ecosystem
Author-email: Angel Daniel Sanchez Castillo <angeldaniel.sanchezcastillo@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Angel Daniel Sanchez Castillo
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/AngelDanielSanchezCastillo/2fast-handbook
Project-URL: Documentation, https://github.com/AngelDanielSanchezCastillo/2fast-handbook/tree/main/docs
Project-URL: Repository, https://github.com/AngelDanielSanchezCastillo/2fast-handbook
Project-URL: Issues, https://github.com/AngelDanielSanchezCastillo/2fast-handbook/issues
Keywords: 2fast,fastapi,handbook,skills,conventions,documentation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Framework :: FastAPI
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# 🚀 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.

> [!WARNING] Internal Use Notice — Solautyc Team

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

```bash
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](docs/structure.md)
- [Naming conventions](docs/naming.md)
- [pyproject.toml](docs/pyproject.md)
- [Settings](docs/settings.md)
- [MANIFEST.in](docs/manifest.md)
- [README](docs/readme.md)
- [Versioning](docs/versioning.md)
- [Release](docs/release.md)
- [Commits](docs/commits.md)
- [Skills](docs/skills.md)

## License

This project is licensed under the MIT License.
