Installation¶

Myxo is on PyPI, as myxo.

Requirements¶

• A POSIX system: Linux or macOS. Myxo uses POSIX file locks, so it doesn't run on Windows.
• Python 3.14 or later. uv installs it for you if the machine lacks it.
• uv, to manage the project. These pages use it; pip works as well.
• PostgreSQL, from step 2 of the continuum. Myxo creates its tables, while the database and its user must exist.

Add it to a project¶

Create a project, and add Myxo:

$ uv init --package --python 3.14 hello
$ cd hello
$ uv add myxo
$ uv run myxo --help

With pip, run pip install myxo in a virtual environment of Python 3.14.

Extras¶

PostgreSQL needs the driver that the postgresql extra brings. Add it from the start, or when the application moves to PostgreSQL:

$ uv add 'myxo[postgresql]'

A second extra, aiohttp, brings the HTTP client of that name, for a process whose http_client names it. A layout that needs a missing extra is refused with the extra's name.

To deliver the application to a server, build its wheel with uv build --wheel: the Hop3 guide and the systemd guide show how.

Next¶

Continue with the Quick Start.