Python tooling for Polylith
A command line interface that adds tooling support for the Polylith Architecture in Python.
Documentation
Have a look at the documentation. You will find installation, setup, usage guides and more.
Quick start
Poetry user? For Poetry, the recommended setup is to install the poetry-polylith-plugin.
Read more about Poetry in the documentation.
Setup for Hatch users
Create a directory for your code, initialize it with git and setup the basics with hatch:
git init
hatch new --init
Add the Polylith CLI as a dev dependency in pyproject.toml:
[tool.hatch.envs.default]
dependencies = ["polylith-cli"]
Add configuration for a local virtual environment in the pyproject.toml:
[tool.hatch.envs.default]
type = "virtual"
path = ".venv"
python = "3.12" # your preferred version here
Make Hatch aware of the Polylith structure, by adding this to the pyproject.toml:
[tool.hatch.build]
dev-mode-dirs = ["components", "bases", "development", "."]
Next: create a Polylith workspace, with a basic Polylith folder structure.
The poly command is now available in the local virtual environment.
You can run commands in the context of hatch run to make Polylith aware of the development environment.
hatch run poly create workspace --name my_namespace --theme loose
Ready for coding!
Add components, bases and projects:
hatch run poly create component --name my_component
hatch run poly create base --name my_example_endpoint
hatch run poly create project --name my_example_project
For details, have a look at the documentation. There, you will find guides for setup, migration, packaging, available commands, code examples and more.
Setup for PDM users
Create a directory for your code, initialize it with git and setup the basics with PDM.
git init
pdm init -n --backend pdm-backend minimal
Add a workspace hook
Make PDM aware of the Polylith structure, by adding the pdm-polylith-workspace hook to the newly created pyproject.toml.
The build hook will add an additional pth file to the virtual environment,
with paths to the Polylith source code folders (bases, components).
[build-system]
requires = ["pdm-backend", "pdm-polylith-workspace"]
build-backend = "pdm.backend"
Add the polylith-cli
Add the Polylith CLI as a dev dependency and setup the virtual environment paths.
touch README.md
pdm add -d polylith-cli
pdm install
Next: create a Polylith workspace, with a basic Polylith folder structure.
The poly command is now available in the local virtual environment.
You can run commands in the context of pdm run to make Polylith aware of the development environment.
pdm run poly create workspace --name my_namespace --theme loose
Ready for coding!
Add components, bases and projects:
pdm run poly create component --name my_component
pdm run poly create base --name my_example_endpoint
pdm run poly create project --name my_example_project
Setup for Rye users
rye init my_repo # name your repo
cd my_repo
rye add polylith-cli --dev
rye sync # create a virtual environment and lock files
Create a workspace, with a basic Polylith folder structure.
rye run poly create workspace --name my_namespace --theme loose
Setup for uv users
uv init -name my_repo # name your repo
cd my_repo
uv add polylith-cli --dev
uv sync # create a virtual environment and lock files
Create a workspace, with a basic Polylith folder structure.
uv run poly create workspace --name my_namespace --theme loose
Rye and uv users: edit the configuration
The default build backend for Rye and uv is Hatch. Make Rye and uv (and Hatch) aware of the way Polylith organizes source code:
[tool.hatch.build]
dev-mode-dirs = ["components", "bases", "development", "."]
Run the sync command to update the virtual environment:
Rye:
rye sync
uv:
uv sync
Finally, remove the src boilerplate code that was added by Rye and uv in the first step:
rm -r src
Rye and uv users: ready for coding!
Add components, bases and projects:
Rye:
rye run poly create component --name my_component
rye run poly create base --name my_example_endpoint
rye run poly create project --name my_example_project
uv:
uv run poly create component --name my_component
uv run poly create base --name my_example_endpoint
uv run poly create project --name my_example_project
For details, have a look at the documentation. There, you will find guides for setup, migration, packaging, available commands, code examples and more.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file polylith_cli-1.50.0.tar.gz.
File metadata
- Download URL: polylith_cli-1.50.0.tar.gz
- Upload date:
- Size: 100.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5d5af88abbe6b5f48b1aff10bb0144c7ecf67571cbcd2e1ff44ca9204004cbd5
|
|
| MD5 |
b075c8cb9178cabcec3daec80129b7f7
|
|
| BLAKE2b-256 |
247f1364091fcb5555606ad6db6900770974ccc61ad419f0464049392758439e
|
File details
Details for the file polylith_cli-1.50.0-py3-none-any.whl.
File metadata
- Download URL: polylith_cli-1.50.0-py3-none-any.whl
- Upload date:
- Size: 170.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
37b5beb8afed42cf07cd3d0fc7679cb53297de2c71a297f55f5e771ba73b621c
|
|
| MD5 |
f1c9510a8aeebdad5a8a8b4b65c4066f
|
|
| BLAKE2b-256 |
7ea4b12a493d37f2fed8eafe5cd2ad696f2cbd2277bc93297928aebd877928f3
|
