You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: mkdocs/docs/contributing.md
+10-12Lines changed: 10 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,33 +34,31 @@ For first-time contributors, feel free to check out our [good first issues](http
34
34
35
35
The PyIceberg Project is hosted on GitHub at <https://github.com/apache/iceberg-python>.
36
36
37
-
For the development, Poetry is used for packing and dependency management. You can install this using:
37
+
For the development, uv is used for packing and dependency management. You can install this using:
38
38
39
39
```bash
40
-
make install-poetry
40
+
make install-uv
41
41
```
42
42
43
-
To get started, you can run `make install`, which installs all the dependencies of the Iceberg library. This also installs the development dependencies. If you don't want to install the development dependencies, you need to install using `poetry install --without dev` instead of `make install`.
43
+
To get started, you can run `make install`, which installs all the dependencies of the Iceberg library. This also installs the development dependencies. If you don't want to install the development dependencies, you need to install using `uv sync --no-dev` instead of `make install`.
44
44
45
-
If you want to install the library on the host, you can simply run `pip3 install -e .`. If you wish to use a virtual environment, you can run `poetry shell`. Poetry will open up a virtual environment with all the dependencies set.
45
+
If you want to install the library on the host, you can simply run `pip3 install -e .`. If you wish to use a virtual environment, you can run `uv venv` to create one and then activate it.
46
46
47
-
> **Note:**If you want to use `poetry shell`, you need to install it using `pip install poetry-plugin-shell`. Alternatively, you can run commands directly with `poetry run`.
47
+
> **Note:**You can run commands directly with `uv run`to execute them in the project environment.
48
48
49
-
To set up IDEA with Poetry:
49
+
To set up IDEA with uv:
50
50
51
51
- Open up the Python project in IntelliJ
52
-
- Make sure that you're on latest main (that includes Poetry)
52
+
- Make sure that you're on latest main (that includes uv)
53
53
- Go to File -> Project Structure (⌘;)
54
54
- Go to Platform Settings -> SDKs
55
55
- Click the + sign -> Add Python SDK
56
-
- Select Poetry Environment from the left hand side bar and hit OK
56
+
- Select the uv virtual environment from the project directory and hit OK
57
57
- It can take some time to download all the dependencies based on your internet
58
58
- Go to Project Settings -> Project
59
-
- Select the Poetry SDK from the SDK dropdown, and click OK
59
+
- Select the uv SDK from the SDK dropdown, and click OK
60
60
61
-
For IDEA ≤2021 you need to install the [Poetry integration as a plugin](https://plugins.jetbrains.com/plugin/14307-poetry/).
62
-
63
-
Now you're set using Poetry, and all the tests will run in Poetry, and you'll have syntax highlighting in the pyproject.toml to indicate stale dependencies.
61
+
Now you're set using uv, and all the tests will run in uv, and you'll have dependency management through the pyproject.toml file.
0 commit comments