From 706d5d6007fc0a98a3a8f0d9e71104f27aa80aa9 Mon Sep 17 00:00:00 2001 From: Vitaly Neyman Date: Wed, 17 Apr 2024 01:20:10 +0300 Subject: [PATCH] Update 'pip install -e' command in documentation to add double quotes, so it also works under zsh and on macosx, not only on bash/sh shells --- .github/workflows/ci.yml | 2 +- CONTRIBUTING.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4b5cd20..88501e2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,7 +22,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install -e .[dev] # Install package in editable mode with dev dependencies + pip install -e ".[dev]"" # Install package in editable mode with dev dependencies - name: Run tests run: | diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f0b113b..a102b97 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,7 +40,7 @@ Install the project dependencies in editable mode (with the '-e' argument). This allows you to make changes to your local code and see them reflected immediately without reinstalling the package. ```bash -pip install -e .[dev] +pip install -e ".[dev]" ``` ### Run tests @@ -68,7 +68,7 @@ The tool would automatically recognize that the file is present and will try to ### Running the Tool To run the tool from your development environment, you can use the command-line interface set up in the project. -Since the package is installed in editable mode (e.g. via `pip install -e .[dev]`), you can run the tool directly from the source code without +Since the package is installed in editable mode (e.g. via `pip install -e ".[dev]"`), you can run the tool directly from the source code without needing a separate installation step for testing changes. To execute the tool, use the following command: