From efc8b5ac0f16717f776e034ecf9a9e9bdabd8424 Mon Sep 17 00:00:00 2001 From: Gabriel Igliozzi Date: Tue, 18 Feb 2025 07:19:38 -0800 Subject: [PATCH] Add instruction to install shell plugin to doc (#1674) More context [here](https://github.com/apache/iceberg-python/pull/1673) Wanted to keep it as short as possible @kevinjqliu --- mkdocs/docs/contributing.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mkdocs/docs/contributing.md b/mkdocs/docs/contributing.md index 3aa70cb947..abce5700fc 100644 --- a/mkdocs/docs/contributing.md +++ b/mkdocs/docs/contributing.md @@ -52,6 +52,8 @@ To get started, you can run `make install`, which installs Poetry and all the de 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. +> **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`. + To set up IDEA with Poetry: - Open up the Python project in IntelliJ