Skip to content

Commit 45e2e91

Browse files
authored
[Docs] Improve contributing docs (#1965)
<!-- Thanks for opening a pull request! --> <!-- In the case this PR will resolve an issue, please replace ${GITHUB_ISSUE_ID} below with the actual Github issue id. --> <!-- Closes #${GITHUB_ISSUE_ID} --> Closes #1964 # Rationale for this change Following all steps in the contributing docs leads to error. Running `make install-poetry` should be done before the environment is activated. # Are these changes tested? Yes # Are there any user-facing changes? No <!-- In the case of user-facing changes, please add the changelog label. -->
1 parent c84017d commit 45e2e91

File tree

1 file changed

+2
-10
lines changed

1 file changed

+2
-10
lines changed

mkdocs/docs/contributing.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,10 @@ The PyIceberg Project is hosted on GitHub at <https://github.com/apache/iceberg-
3737
For the development, Poetry is used for packing and dependency management. You can install this using:
3838

3939
```bash
40-
pip install poetry
40+
make install-poetry
4141
```
4242

43-
Make sure you're using an up-to-date environment from venv
44-
45-
```bash
46-
pip install --upgrade virtualenv pip
47-
python -m venv ./venv
48-
source ./venv/bin/activate
49-
```
50-
51-
To get started, you can run `make install`, which installs Poetry and 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 --no-dev`.
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`.
5244

5345
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.
5446

0 commit comments

Comments
 (0)