Merge pull request #9173 from OpenMined/snwagh/shell-agnostic-install…

…-readme Adding pip install quotes for zsh support
OpenMined · Aug 14, 2024 · ed1f17a · ed1f17a
2 parents eab4311 + ecbfbda
commit ed1f17a
Show file tree

Hide file tree

Showing 14 changed files with 24 additions and 24 deletions.
diff --git a/.github/workflows/cd-docs.yml b/.github/workflows/cd-docs.yml
@@ -28,7 +28,7 @@ jobs:
       - name: Install pip dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Build the docs

diff --git a/.github/workflows/cd-feature-branch.yml b/.github/workflows/cd-feature-branch.yml
@@ -65,7 +65,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0 bump2version==1.0.1
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0 bump2version==1.0.1
           uv --version
 
       - name: Generate Release Metadata
@@ -290,7 +290,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0 setuptools wheel twine bump2version PyYAML
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0 setuptools wheel twine bump2version PyYAML
           uv --version
 
       - name: Bump to Final Release version

diff --git a/.github/workflows/cd-post-release-tests.yml b/.github/workflows/cd-post-release-tests.yml
@@ -119,7 +119,7 @@ jobs:
       - name: Install pip dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Get uv cache dir
@@ -195,7 +195,7 @@ jobs:
 
       - name: Install tox and uv
         run: |
-          pip install uv==0.2.17 tox tox-uv==1.9.0 tox-current-env
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0 tox-current-env
 
       - name: Run unit tests
         run: |

diff --git a/.github/workflows/cd-syft.yml b/.github/workflows/cd-syft.yml
@@ -114,7 +114,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0 bump2version==1.0.1
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0 bump2version==1.0.1
           uv --version
 
       - name: Get Release tag
@@ -392,7 +392,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0 setuptools wheel twine bump2version PyYAML
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0 setuptools wheel twine bump2version PyYAML
           uv --version
 
       - name: Bump the Version

diff --git a/.github/workflows/cd-syftcli.yml b/.github/workflows/cd-syftcli.yml
@@ -122,7 +122,7 @@ jobs:
       - name: Install pip dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Build syftcli

diff --git a/.github/workflows/e2e-tests-notebook.yml b/.github/workflows/e2e-tests-notebook.yml
@@ -60,7 +60,7 @@ jobs:
       - name: Install pip dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Get pip cache dir

diff --git a/.github/workflows/post-merge-tasks.yml b/.github/workflows/post-merge-tasks.yml
@@ -27,7 +27,7 @@ jobs:
       - name: Install pip packages
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Check and Bump Protocol Version

diff --git a/.github/workflows/pr-tests-frontend.yml b/.github/workflows/pr-tests-frontend.yml
@@ -47,7 +47,7 @@ jobs:
         if: steps.changes.outputs.frontend == 'true'
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Get uv cache dir

diff --git a/.github/workflows/pr-tests-helm-lint.yml b/.github/workflows/pr-tests-helm-lint.yml
@@ -34,7 +34,7 @@ jobs:
 
           # Install python deps
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
 
           kube-linter version
           polaris version

diff --git a/.github/workflows/pr-tests-helm-upgrade.yml b/.github/workflows/pr-tests-helm-upgrade.yml
@@ -38,7 +38,7 @@ jobs:
 
           # Install python deps
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
 
           # Install kubernetes
           brew install helm k3d devspace kubectl

diff --git a/.github/workflows/pr-tests-linting.yml b/.github/workflows/pr-tests-linting.yml
@@ -30,7 +30,7 @@ jobs:
       - name: Install pip packages
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Get uv cache dir

diff --git a/.github/workflows/pr-tests-stack.yml b/.github/workflows/pr-tests-stack.yml
@@ -53,7 +53,7 @@ jobs:
         if: steps.changes.outputs.stack == 'true'
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Run syft backend base image building test
@@ -96,7 +96,7 @@ jobs:
         if: steps.changes.outputs.stack == 'true'
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Get uv cache dir
@@ -179,7 +179,7 @@ jobs:
         if: steps.changes.outputs.stack == 'true'
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Get uv cache dir
@@ -328,7 +328,7 @@ jobs:
         if: steps.changes.outputs.stack == 'true'
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Get uv cache dir
@@ -455,7 +455,7 @@ jobs:
         if: steps.changes.outputs.syft == 'true'
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Get uv cache dir

diff --git a/.github/workflows/pr-tests-syft.yml b/.github/workflows/pr-tests-syft.yml
@@ -66,7 +66,7 @@ jobs:
         if: steps.changes.outputs.syft == 'true'
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Get uv cache dir
@@ -157,7 +157,7 @@ jobs:
         if: steps.changes.outputs.syft == 'true'  || steps.changes.outputs.notebooks == 'true'
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Get uv cache dir
@@ -235,7 +235,7 @@ jobs:
         if: steps.changes.outputs.stack == 'true' || steps.changes.outputs.notebooks == 'true'
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Get uv cache dir
@@ -332,7 +332,7 @@ jobs:
         if: steps.changes.outputs.syft == 'true'
         run: |
           python -m pip install --upgrade pip
-          pip install uv==0.2.17 tox tox-uv==1.9.0
+          pip install uv==0.2.17 tox==4.16.0 tox-uv==1.9.0
           uv --version
 
       - name: Get uv cache dir

diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ Try out your <a href="https://docs.openmined.org/en/latest/index.html">first que
 ## Install Client
 
 ```bash
-$ pip install -U syft[data_science]
+pip install -U "syft[data_science]"
 ```
 
 More instructions are available <a href="https://docs.openmined.org/en/latest/quick_install.ipynb">here</a>.