From dfead2e3bcd09061a6341493f6d73e2c3569bbc1 Mon Sep 17 00:00:00 2001 From: Peter Nguyen Date: Sat, 3 May 2025 13:38:41 -0700 Subject: [PATCH 1/2] Improve contributing.md --- mkdocs/docs/contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs/docs/contributing.md b/mkdocs/docs/contributing.md index abce5700fc..fd7f2918f4 100644 --- a/mkdocs/docs/contributing.md +++ b/mkdocs/docs/contributing.md @@ -37,7 +37,7 @@ The PyIceberg Project is hosted on GitHub at Date: Mon, 5 May 2025 17:53:25 -0700 Subject: [PATCH 2/2] Change --no-dev to --without dev and remove venv instructions --- mkdocs/docs/contributing.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/mkdocs/docs/contributing.md b/mkdocs/docs/contributing.md index fd7f2918f4..454da882c7 100644 --- a/mkdocs/docs/contributing.md +++ b/mkdocs/docs/contributing.md @@ -40,15 +40,7 @@ For the development, Poetry is used for packing and dependency management. You c make install-poetry ``` -Make sure you're using an up-to-date environment from venv - -```bash -pip install --upgrade virtualenv pip -python -m venv ./venv -source ./venv/bin/activate -``` - -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 --no-dev` instead of `make install`. +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`. 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.