Rust and Release (#151)

Author: njooma

.github/workflows/docs.yml

@@ -23,7 +23,7 @@ jobs:
         uses: snok/install-poetry@v1
 
       - name: Install package
-        run: poetry install
+        run: make install
 
       - name: Generate docs
         run: |

.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  release:
+    if: github.repository_owner == 'viamrobotics' && github.ref == 'refs/heads/main' && contains(fromJson('["njooma"]'), github.actor)
+    runs-on: [self-hosted, x64]
+    container:
+      image: ghcr.io/viamrobotics/canon:amd64
+
+    steps:
+      - name: Download Release
+        uses: dsaltares/fetch-gh-release-asset@master
+        with:
+          file: 'viam_sdk.*\\.whl'
+          regex: true
+          target: 'dist/'
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/release.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
     inputs:
       version:
-        description: 'The type of version bump. Select "-s" for no automatic version change. See https://python-poetry.org/docs/cli/#version'
+        description: 'The type of version bump. Select "-s" for no version change. See https://python-poetry.org/docs/cli/#version'
         type: choice
         required: true
         default: '-s'
@@ -16,29 +16,20 @@ on:
         - preminor
         - prepatch
         - prerelease
-        - prerelease
-        - prerelease
         - '-s'
 
 jobs:
   prepare:
-    # if: github.repository_owner == 'viamrobotics' && github.ref == 'refs/heads/main'
-    # runs-on: [self-hosted, x64]
-    # container:
-    #   image: ghcr.io/viamrobotics/canon:amd64
-    runs-on: ubuntu-latest
+    if: github.repository_owner == 'viamrobotics' && github.ref == 'refs/heads/main' && contains(fromJson('["njooma"]'), github.actor)
+    runs-on: [self-hosted, x64]
+    container:
+      image: ghcr.io/viamrobotics/canon:amd64
     outputs:
       sha: ${{ steps.commit.outputs.commit_long_sha }}
+      version: ${{ steps.bump_version.outputs.version }}
     steps:
       - name: Checkout Code
         uses: actions/checkout@v3
-        # with:
-        #   token: ${{ secrets.REPO_READ_TOKEN }}
-
-      # TODO: REMOVE
-      - uses: actions/setup-python@v4
-        with:
-          python-version: '3.10'
 
       - name: Install Poetry
         uses: snok/install-poetry@v1
@@ -54,29 +45,21 @@ jobs:
         run: |
           poetry version ${{ inputs.version }}
           echo "SDK_VERSION=$(poetry version -s)" >> $GITHUB_ENV
-
-      - name: Download Compiled Rust
-        uses: dsaltares/fetch-gh-release-asset@master
-        with:
-          repo: 'viamrobotics/viam-rust-sdk'
-          file: 'libviam-.*'
-          regex: true
-          target: 'bin/'
+          echo "::set-output name=version::$(poetry version -s)"
 
       - name: Commit + Push
         id: commit
         uses: EndBug/[email protected]
         with:
           default_author: github_actions
-          message: Bumping prerelease version to v${{ env.SDK_VERSION }} [skip ci]
+          message: Bumping version to v${{ env.SDK_VERSION }} [skip ci]
 
   build:
     needs: prepare
-    # if: github.repository_owner == 'viamrobotics' && github.ref == 'refs/heads/main'
-    # runs-on: [self-hosted, x64]
-    # container:
-    #   image: ghcr.io/viamrobotics/canon:amd64
-    runs-on: ubuntu-latest
+    if: github.repository_owner == 'viamrobotics' && github.ref == 'refs/heads/main'
+    runs-on: [self-hosted, x64]
+    container:
+      image: ghcr.io/viamrobotics/canon:amd64
     strategy:
       matrix:
         include:
@@ -88,39 +71,52 @@ jobs:
             whl: macosx_11_0_arm64
           - arch: linux_aarch64
             ext: so
-            whl: linux_aarch64
+            whl: manylinux2014_aarch64
           - arch: linux_x86_64
             ext: so
-            whl: linux_x86_64
+            whl: manylinux2014_x86_64
     steps:
       - name: Checkout Code
         uses: actions/checkout@v3
         with:
           ref: ${{ needs.prepare.outputs.sha }}
-        #   token: ${{ secrets.REPO_READ_TOKEN }}
-
-      # TODO: REMOVE
-      - uses: actions/setup-python@v4
-        with:
-          python-version: '3.10'
 
       - name: Install Poetry
         uses: snok/install-poetry@v1
 
       - name: Install package
         run: poetry install
 
-      - name: Copy
-        run: cp bin/libviam-${{ matrix.arch }}.${{ matrix.ext }} src/viam/rpc/libviam.${{ matrix.ext }}
+      - name: Download binary
+        run: curl -sL -o src/viam/rpc/libviam.${{ matrix.ext }} https://github.com/viamrobotics/viam-rust-sdk/releases/latest/download/libviam-${{ matrix.arch }}.${{ matrix.ext }}
 
       - name: Build
-        run: poetry build
+        run: poetry build -f wheel
 
       - name: Rename
-        run: mv dist/viam-$(poetry run python -c "import viam; print(viam.__version__)")-py3-none-any.whl dist/viam-$(poetry run python -c "import viam; print(viam.__version__)")-py3-none-${{ matrix.whl }}.whl
+        run: mv dist/viam_sdk-$(poetry run python -c "import viam; print(viam.__version__)")-py3-none-any.whl dist/viam_sdk-$(poetry run python -c "import viam; print(viam.__version__)")-py3-none-${{ matrix.whl }}.whl
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v3
         with:
           name: dist
           path: dist
+
+  release:
+    needs: [prepare, build]
+    if: github.repository_owner == 'viamrobotics' && github.ref == 'refs/heads/main'
+    runs-on: [self-hosted, x64]
+    container:
+      image: ghcr.io/viamrobotics/canon:amd64
+
+    steps:
+      - uses: actions/download-artifact@v3
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: v${{ needs.prepare.outputs.version }}
+          files: dist/*
+          draft: true
+          prerelease: ${{ contains(inputs.version, 'pre') }}
+          fail_on_unmatched_files: true

.github/workflows/test.yml

@@ -27,7 +27,7 @@ jobs:
         uses: snok/install-poetry@v1
 
       - name: Install package
-        run: poetry install
+        run: make install
 
       - name: Lint
         run: make lint

.gitignore

@@ -130,6 +130,7 @@ dmypy.json
 .pyre/
 
 # Tools
+bin/
 **/.DS_Store
 
 # license finder

Makefile

@@ -43,6 +43,7 @@ _test_docs:
 test_docs:
 	kill -9 `ps aux | grep "[e]xamples.server.v1.server" | awk '{print $$2}'` || true
 	poetry run python3 -m examples.server.v1.server 0.0.0.0 9091 quiet &
+	sleep 3
 	poetry run make _test_docs
 	kill -9 `ps aux | grep "[e]xamples.server.v1.server" | awk '{print $$2}'`
 

README.md

@@ -8,30 +8,44 @@
 > **Warning**
 > This is an alpha release of the Viam Python SDK. Stability is not guaranteed. Breaking changes are likely to occur, and occur often.
 
-## Installation - pre PyPI
+## Installation
+Currently, we have pre-built binaries for macOS (both Intel and Apple Silicon), along with Linux (x86 and aarch64) that you can install via pip
 
-To install the Viam Python SDK from the current `main` branch, use the following command:
+`pip install viam-sdk`
 
-```
-pip install git+https://github.com/viamrobotics/python-sdk.git
-```
-
-To install the the Viam Python SDK from a specific branch or commit, use the following command:
-
-```
-pip install git+https://github.com/viamrobotics/python-sdk.git@FULL_COMMIT_HASH
-```
+If your system is not supported, read further on how to install from source.
 
 ### Upgrading
 
 > **Note**
-> Because the SDK is under active development, we suggest that you upgrade the package frequently. 
- 
+> Because the SDK is under active development, we suggest that you upgrade the package frequently.
+
 To upgrade, simply run the `pip install` command with the `-U` option:
+`pip install -U viam-sdk`
+
+### Installing from Source
+The Viam Python SDK uses native libraries to support communication over WebRTC, which will allow you to connect to robots that are not on the same network. In order to facilitate that communication, there is a [Rust SDK](https://github.com/viamrobotics/viam-rust-sdk) that contains the necessary protocols. Therefore, to build from source, you will need both the Rust SDK and the Rust compiler.
+
+1. Download/clone this repository
+1. Download/clone the [Rust SDK](https://github.com/viamrobotics/viam-rust-sdk)
+1. [Install Rust](https://www.rust-lang.org/tools/install) if not already available
+1. From the `viam-rust-sdk` directory, run `cargo build`
+    * You can optionally provide the `--release` flag: `cargo build --release`
+1. Find the compiled library in `viam-rust-sdk/target/debug/libviam.*`
+    * If you provided the `--release` flag, the enclosing directory will be `release`: `viam-rust-sdk/target/release/libviam.*`
+    * The extension of the executable will depend on your operating system. For example, on macOS it will be `libviam.dylib`, whereas on Linux it will be `libviam.so`
+1. Copy the compiled library to the directory `viam-python-sdk/src/viam/rpc/`
+1. From the `viam-python-sdk` directory, run `poetry build` to create an installable package
+1. Find the newly created installable package located in `viam-python-sdk/dist/` and pip install it directly, e.g.: `pip install viam-python-sdk/dist/viam_sdk-0.1.0-py3-none-any.whl`
 
-```
-pip install -U git+https://github.com/viamrobotics/python-sdk.git
-```
+
+If you do **NOT** need communication over WebRTC (and thus, do not need the native library), the steps are:
+
+1. Download/clone this repository
+1. Run `poetry build` from the `viam-python-sdk` directory
+1. Find the newly created installable package located in `viam-python-sdk/dist/` and pip install it directly, e.g.: `pip install viam-python-sdk/dist/viam_sdk-0.1.0-py3-none-any.whl`
+1. Ensure that every connection has the option `disable_webrtc` set to `True`: `viam.rpc.dial.DialOptions(disable_webrtc=True)`
+    * For more information about connecting to a robot, see the [documentation](https://python.viam.dev) and [example usage](https://python.viam.dev/examples/example.html)
 
 ## Configure a client application at [app.viam.com](https://app.viam.com)
 
@@ -47,7 +61,7 @@ To create a client application, to navigate to [app.viam.com](https://app.viam.c
    3. Wait until the robot shows as connected. If this doesn't happen try restarting the viam-server:
       ```
       sudo systemctl restart viam-server
-      ```   
+      ```
 
 Next, select the `CONNECT` tab in the Viam Web UI, and copy the boilerplate code from the section labeled `Python SDK`.