Merge pull request #70 from OpenMined/rasswanth/update_readme

[CD] Misc Changes

.github/workflows/cd-release.yaml

@@ -16,6 +16,15 @@ on:
         description: "Perform a test bump version without pushing to pypi and repo"
         type: boolean
         default: false
+
+      skip_tests:
+        description: "If true, skip pre-release tests"
+        required: false
+        default: "false"
+        type: choice
+        options:
+          - "false"
+          - "true"
 
 # Prevents concurrent runs of the same workflow
 # while the previous run is still in progress
@@ -24,7 +33,13 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
+  call-pr-tests:
+    if: ${{ inputs.skip_tests == 'false' }}
+    uses: ./.github/workflows/pr-tests.yaml
+
+
   deploy-syftbox:
+    needs: [call-pr-tests]
     runs-on: ubuntu-latest
 
     steps:
@@ -70,4 +85,4 @@ jobs:
       - name: Push changes to SyftBox repo
         if: ${{ inputs.test_bump == false }}
         run: |
-          git push origin main
+          git push origin

README.md

@@ -17,9 +17,9 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
 
 uv venv .venv
 
-## install the wheel
+## Install Syftbox
 
-uv pip install http://20.168.10.234:8080/wheel/syftbox-0.1.0-py3-none-any.whl --reinstall
+uv pip install -U syftbox
 
 ## run the client
 

syftbox/server/server.py

@@ -179,8 +179,8 @@ async def lifespan(app: FastAPI):
 # create a virtualenv somewhere
 uv venv .venv
 
-# install the wheel
-uv pip install http://20.168.10.234:8080/wheel/syftbox-0.1.0-py3-none-any.whl --reinstall
+# Install SyftBox
+uv pip install -U syftbox
 
 # run the client
 uv run syftbox client