Installation

Installation is as simple as:

pipuv

pip install plateforme

uv add plateforme

Plateforme has a few dependencies:

• sqlalchemy, alembic, aiosqlite: Object-relational mapping, migration tools, and database support.
• pydantic, pydantic-core, pydantic-settings: Data validation and settings management.
• fastapi: Routing and middleware built on top of Starlette.
• python-dotenv: Environment variable management.

If you've got Python 3.11+ and pip installed, you're good to go.

Optional dependencies

Plateforme has the following optional dependencies:

• cli: Command-line interface tools powered by the typer, questionary, rich, and jinja2 packages.
• lint: Code linting and formatting provided by the mypy and ruff packages.
• serve: Development server provided by the uvicorn package.
• test: Testing tools provided by the pytest, coverage, and faker packages.

All optional dependencies can be installed with the all extra

To install optional dependencies along with Plateforme:

pipuv

# with the "cli" extra:
pip install "plateforme[cli]"

# or with "cli" and "serve" extras:
pip install "plateforme[cli,serve]"

# or with all extras:
pip install "plateforme[all]"

# with the "cli" extra:
uv add "plateforme[cli]"

# or with "cli" and "serve" extras:
uv add "plateforme[cli,serve]"

# or with all extras:
uv add "plateforme[all]"

You can also install requirements manually with for instance pip install uvicorn

Install from repository

And if you prefer to install Plateforme directly from the repository:

pipuv

pip install "git+https://github.com/plateformeio/plateforme@main"

# or with "cli" and "serve" extras:
pip install "git+https://github.com/plateformeio/plateforme@main#egg=plateforme[cli,serve]"

uv add "git+https://github.com/plateformeio/plateforme@main"

# or with "cli" and "serve" extras:
uv add "git+https://github.com/plateformeio/plateforme@main#egg=plateforme[cli,serve]"