Welcome!¶

Thanks for considering contributing to FastOpenAPI 🎉
This guide explains how to get started, make contributions, write commits, open pull requests, and run tests.

Setup & Running¶

Install dependencies with:

# Fork the repo on GitHub first, then:
git clone https://github.com/yourusername/fastopenapi.git
cd fastopenapi
poetry install --all-extras

poetry install already pulls in the dev tools (the dev group); adding --all-extras also installs every framework (aiohttp, Django, Falcon, Flask, Quart, Sanic, Starlette, Tornado) so the full test suite can run.

If you don't use poetry, install the package in editable mode with the framework extras you need plus the dev tools manually (there is no dev extra — the dev tools live in Poetry's dev group):

pip install -e ".[aiohttp,falcon,flask,quart,sanic,starlette,tornado,django]"
pip install pytest pytest-asyncio anyio trio httpx coverage black flake8 isort pre-commit mypy

Project Structure¶

fastopenapi/ — core library
examples/ — examples for different frameworks
tests/ — tests for each supported framework
benchmarks/ — performance comparisons
docs/ — documentation (English)

Running Tests¶

To run tests:

pytest

Tests cover both internal logic and integration with aiohttp, flask, sanic, and more.

Code Style¶

This project uses:

black — code formatting
flake8 — linting
isort — import sorting
pre-commit — hooks for clean code before commit

Install pre-commit hooks:

pre-commit install

Run all checks manually:

pre-commit run --all-files

Git & Pull Requests¶

Fork the repository
Create a new branch: feature/your-feature or fix/your-fix
Keep commits atomic and meaningful
Open a PR with a clear description:
What was added/changed?
Which frameworks were affected?
How was it tested?

Documentation¶

If your change affects public APIs or behavior, update the relevant documentation: - docs/

Feedback¶

Not sure how to implement a feature?
Feel free to open an issue with your proposal. We’re happy to discuss it with you!