Skip to content

Commit 5e33cd8

Browse files
authored
docs: add Pixi-specific docs about setup, commands and packaging (#23)
1 parent a59df6f commit 5e33cd8

File tree

3 files changed

+71
-4
lines changed

3 files changed

+71
-4
lines changed

docs/commands.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ rye run poly create workspace --name my_example_namespace --theme loose
3030
uv run poly create workspace --name my_example_namespace --theme loose
3131
```
3232

33+
#### Pixi
34+
``` shell
35+
pixi run poly create workspace --name my_example_namespace --theme loose
36+
```
37+
3338
#### Maturin
3439

3540
``` shell
@@ -118,6 +123,11 @@ rye run poly create component --name my_example_component
118123
uv run poly create component --name my_example_component
119124
```
120125

126+
#### Pixi
127+
``` shell
128+
pixi run poly create component --name my_example_component
129+
```
130+
121131
#### Maturin
122132
``` shell
123133
# if not already activated a virtual environment
@@ -160,6 +170,11 @@ rye run poly create base --name my_example_base
160170
uv run poly create base --name my_example_base
161171
```
162172

173+
#### Pixi
174+
``` shell
175+
pixi run poly create base --name my_example_base
176+
```
177+
163178
#### Maturin
164179
``` shell
165180
# if not already activated a virtual environment
@@ -202,6 +217,11 @@ rye run poly create project --name my_example_project
202217
uv run poly create project --name my_example_project
203218
```
204219

220+
#### Pixi
221+
``` shell
222+
pixi run poly create project --name my_example_project
223+
```
224+
205225
#### Maturin
206226
``` shell
207227
# if not already activated a virtual environment
@@ -244,6 +264,11 @@ rye run poly info
244264
uv run poly info
245265
```
246266

267+
#### Pixi
268+
``` shell
269+
pixi run poly info
270+
```
271+
247272
#### Maturin
248273
``` shell
249274
# if not already activated a virtual environment
@@ -292,6 +317,11 @@ rye run poly diff
292317
uv run poly diff
293318
```
294319

320+
#### Pixi
321+
``` shell
322+
pixi run poly diff
323+
```
324+
295325
#### Maturin
296326
``` shell
297327
# if not already activated a virtual environment
@@ -345,6 +375,11 @@ rye run poly libs
345375
uv run poly libs
346376
```
347377

378+
#### Pixi
379+
``` shell
380+
pixi run poly libs
381+
```
382+
348383
#### Maturin
349384
``` shell
350385
# if not already activated a virtual environment
@@ -402,6 +437,11 @@ rye run poly check
402437
uv run poly check
403438
```
404439

440+
#### Pixi
441+
``` shell
442+
pixi run poly check
443+
```
444+
405445
#### Maturin
406446
``` shell
407447
# if not already activated a virtual environment
@@ -456,6 +496,11 @@ rye run poly sync
456496
uv run poly sync
457497
```
458498

499+
#### Pixi
500+
``` shell
501+
pixi run poly sync
502+
```
503+
459504
#### Maturin
460505
``` shell
461506
# if not already activated a virtual environment
@@ -502,6 +547,11 @@ rye run poly deps
502547
uv run poly deps
503548
```
504549

550+
#### Pixi
551+
``` shell
552+
pixi run poly deps
553+
```
554+
505555
#### Maturin
506556
``` shell
507557
# if not already activated a virtual environment
@@ -558,6 +608,11 @@ rye run poly test diff
558608
uv run poly test diff
559609
```
560610

611+
#### Pixi
612+
``` shell
613+
pixi run poly test diff
614+
```
615+
561616
#### Maturin
562617
``` shell
563618
# if not already activated a virtual environment

docs/deployment.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Packaging and deploying Polylith projects is done by using the Poetry Multiproje
66
The `poetry build-project` command will make it possible to use relative package includes as how components and bases are added to Python Polylith projects.
77
Relative includes are currently not possible by default in __Poetry__, that is where the __Multiproject__ plugin comes in.
88

9-
## Hatch, PDM, Rye and uv
9+
## Hatch, PDM, Rye, Pixi and uv
1010
Hatch, PDM, Rye and uv support relative includes via the `[tool.poetry.bricks]` configuration.
1111
Nothing extra needed other than the build hooks.
1212

@@ -16,7 +16,7 @@ you will need to add the path in the project-specific `pyroject.toml`.
1616

1717
If you only provide `wheel` distributions, this is optional.
1818

19-
#### Hatch, Rye and uv
19+
#### Hatch, Rye, Pixi and uv
2020
```toml
2121
[tool.hatch.build.targets.wheel]
2222
packages = ["<your top namespace here>"]
@@ -77,6 +77,17 @@ _Are you using the `uv` build backend (and not the recommended `hatch` build bac
7777
_If so, you need to run the `poly build setup` and `poly build teardown` commands before and after the `uv build` command._
7878
_This is needed because of the missing build hook support of the uv build backend._
7979

80+
#### Pixi
81+
``` shell
82+
cd projects/the_project
83+
84+
pixi run poly build setup
85+
86+
pixi build
87+
88+
pixi run poly build teardown
89+
```
90+
8091
#### Maturin
8192
``` shell
8293
cd projects/the_project

docs/setup.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,8 +265,9 @@ __Choose the name wisely.__ Have a look in [PEP-423](https://peps.python.org/pep
265265
`--theme` the structure of the workspace, `loose` is the recommended structure for Python.
266266

267267
### Pixi
268-
Have a look at the Hatch and Maturin sections for setup, packaging and usage. More details about Pixi setup coming soon!
269-
As of this writing, Pixi has experimental support for building and packaging. The Hatch-specific hooks is not (currently) needed for Pixi.
268+
Have a look at the Pixi docs for initializing a new repo or project.
269+
For the Polylith initial setup, look at the __Hatch__ sections at this page.
270+
270271

271272
### Pantsbuild (aka Pants)
272273
Have a look in the Pants-specific [example repository](examples.md) for details on the setup.

0 commit comments

Comments
 (0)