[BLY-64] Python Spiral v1, and docs

Python client: use spiral v1, add basic docs
Unify client versions at 0.2.0
Add min rustc version to all crates

Author: neilmovva

.github/workflows/build-js.yml

@@ -67,7 +67,7 @@ jobs:
   client-publish:
     name: Publish JavaScript SDK
     runs-on: ubuntu-latest
-    if: ${{ inputs.publish }}
+    if: ${{ inputs.publish || github.ref == 'refs/heads/main' }}
     needs: [client-build]
     steps:
       - uses: actions/checkout@v3

.github/workflows/build-python.yml

@@ -1,8 +1,8 @@
 name: Build Python SDK
 
 env:
-  BLYSS_STAGING_SERVER: https://dev2.api.blyss.dev
-  BLYSS_STAGING_API_KEY: Gh1pz1kEiNa1npEdDaRRvM1LsVypM1u2x1YbGb54
+  BLYSS_STAGING_SERVER: ${{ vars.BLYSS_STAGING_SERVER }}
+  BLYSS_STAGING_API_KEY: ${{ secrets.BLYSS_STAGING_API_KEY }}
 
 on:
   push:
@@ -58,6 +58,24 @@ jobs:
           name: wheels
           path: python/dist
 
+      # only run docs on target x86_64
+      - name: Build Python docs
+        if: matrix.target == 'x86_64'
+        working-directory: python
+        shell: bash
+        # TODO: pdoc is documenting the installed module, not the source folder.
+        # pdoc's import-based docs don't play well with maturin's structure.
+        run: |
+          pip install pdoc
+          pdoc -o pdoc -d google -n blyss --no-search
+
+      - name: Upload Python docs
+        if: matrix.target == 'x86_64'
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: python/pdoc
+
+
   windows:
     runs-on: windows-latest
     needs: [linux]
@@ -126,7 +144,7 @@ jobs:
   publish:
     name: Publish
     runs-on: ubuntu-latest
-    if: ${{ inputs.publish }}
+    if: ${{ inputs.publish || github.ref == 'refs/heads/main' }}
     needs: [linux, macos, windows, sdist]
     steps:
       - uses: actions/download-artifact@v3

.gitignore

@@ -8,3 +8,4 @@ node_modules
 *.pyc
 *build/
 .DS_Store
+.env

README.md

@@ -56,10 +56,19 @@ You can also use the Blyss SDK completely locally.
 2. Run the server by entering `lib/server` and running `cargo run --release`. The server will run on `localhost:8008` by default.
 3. Run the client by entering `examples/node-local` and running `npx ts-node main.ts`. This will perform some writes and then a private read to your bucket.
 
-## Installing as a package
+## Install
 
+### JavaScript / Node
 To use the Blyss SDK in an existing TypeScript project, install it with `npm install @blyss/sdk`. Then, import the client with `import { Client } from '@blyss/sdk';`. If you're using SDK in Node, and prefer not to use ESM, you can instead import it as `const blyss = require('@blyss/sdk/node')`.
 
+### Python
+#### From PyPI:
+`pip install --upgrade blyss`
+
+#### From repo:
+1. `cd python` from repo root.
+2. `pip install --upgrade .`
+
 ## Examples
 
 The `examples/` directory has several examples of how to use the Blyss SDK. Running the examples requires [an API key](https://blyss.dev).
@@ -90,8 +99,8 @@ The Node.js example shows how to use the Blyss SDK in server-side JS. Node 18+ i
 
 ### Python
 
-1. Enter `examples/python`.
-2. Run `pip install blyss`.
+1. Install blyss.
+2. Enter `examples/python`.
 3. Run `python main.py`.
 
 ## Documentation

js/bridge/Cargo.toml

@@ -1,13 +1,14 @@
 [package]
 name = "spiral-rs-js-bridge"
 description = "Bridge crate between the spiral-rs-client library and the JS client"
-version = "0.1.0"
+version = "0.2.0"
 authors = ["Samir Menon <[email protected]>"]
 license = "MIT"
 repository = "https://github.com/blyssprivacy/sdk"
 categories = ["wasm"]
 readme = "README.md"
 edition = "2018"
+rust-version = "1.70.0"
 
 [lib]
 crate-type = ["cdylib", "rlib"]

js/bucket/bucket_service.ts

@@ -9,11 +9,11 @@ export interface BucketParameters {
   version: number;
 }
 
-type MaxItemSizeIdentifier = '100B' | '1KB' | '10KB';
+type MaxItemSizeIdentifier = '100' | '1000' | '10000';
 type kspIdentifier = 'none' | 'bloom' | 'full';
 
 const DEFAULT_BUCKET_PARAMETERS: BucketParameters = {
-  maxItemSize: '1KB',
+  maxItemSize: '1000',
   keyStoragePolicy: 'bloom',
   version: 1
 };

lib/blyss-rs/Cargo.toml

@@ -12,6 +12,7 @@ keywords = ["privacy", "fhe", "cryptography"]
 categories = ["cryptography"]
 readme = "README.md"
 license = "MIT"
+rust-version = "1.70.0"
 
 [dependencies]
 base64 = "0.21.0"

lib/doublepir/Cargo.toml

@@ -2,6 +2,7 @@
 name = "doublepir-rs"
 version = "0.1.0"
 edition = "2021"
+rust-version = "1.70.0"
 
 [features]
 client = ["reqwest", "base64", "sha1"]

lib/server/Cargo.toml

@@ -12,6 +12,7 @@ keywords = ["privacy", "fhe", "cryptography"]
 categories = ["cryptography"]
 readme = "README.md"
 license = "MIT"
+rust-version = "1.70.0"
 
 [[bin]]
 name = "server"