Skip to content

Commit 986c0b4

Browse files
committed
Add pixi to pypi README
1 parent b63ee37 commit 986c0b4

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

docs/package/README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,33 @@
44

55
Pipe based dataframe manipulation library that can also transform data on SQL databases
66

7-
This is an early stage version 0.x which lacks documentation. Please contact
8-
https://github.com/orgs/pydiverse/teams/code-owners if you like to become an early adopter
9-
or to contribute early stage usage examples.
7+
This is an early stage version 0.x, however, it is already used in real projects. We are happy to receive your
8+
feedback as [issues](https://github.com/pydiverse/pydiverse.transform/issues) on the GitHub repo. Feel free to also
9+
comment on existing issues to extend them to your needs or to add solution ideas.
1010

1111
## Usage
1212

1313
pydiverse.transform can either be installed via pypi with `pip install pydiverse-transform` or via conda-forge
14-
with `conda install pydiverse-transform -c conda-forge`.
14+
with `conda install pydiverse-transform -c conda-forge`. Our recommendation would be
15+
to use [pixi](https://pixi.sh/latest/) which is also based on conda-forge:
16+
17+
```bash
18+
mkdir my_project
19+
pixi init
20+
pixi add pydiverse-transform
21+
```
22+
23+
With pixi, you run python like this:
24+
25+
```bash
26+
pixi run python -c 'import pydiverse.transform'
27+
```
28+
29+
or this:
30+
31+
```bash
32+
pixi run python my_script.py
33+
```
1534

1635
## Example
1736

0 commit comments

Comments
 (0)