chore: update SDK settings (#7)

.devcontainer/Dockerfile

@@ -1,23 +1,9 @@
-# syntax=docker/dockerfile:1
-FROM debian:bookworm-slim AS stainless
+ARG VARIANT="3.9"
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
 
-RUN apt-get update && apt-get install -y \
-  nodejs \
-  npm \
-  yarnpkg \
-  && apt-get clean autoclean
+USER vscode
 
-# Ensure UTF-8 encoding
-ENV LANG=C.UTF-8
-ENV LC_ALL=C.UTF-8
+RUN curl -sSf https://rye-up.com/get | RYE_VERSION="0.24.0" RYE_INSTALL_OPTION="--yes" bash
+ENV PATH=/home/vscode/.rye/shims:$PATH
 
-# Yarn
-RUN ln -sf /usr/bin/yarnpkg /usr/bin/yarn
-
-WORKDIR /workspace
-
-COPY package.json yarn.lock /workspace/
-
-RUN yarn install
-
-COPY . /workspace
+RUN echo "[[ -d .venv ]] && source .venv/bin/activate" >> /home/vscode/.bashrc

.devcontainer/devcontainer.json

@@ -3,7 +3,27 @@
 {
   "name": "Debian",
   "build": {
-    "dockerfile": "Dockerfile"
+    "dockerfile": "Dockerfile",
+    "context": ".."
+  },
+
+  "postStartCommand": "rye sync --all-features",
+
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python"
+      ],
+      "settings": { 
+        "terminal.integrated.shell.linux": "/bin/bash",
+        "python.pythonPath": ".venv/bin/python",
+        "python.defaultInterpreterPath": ".venv/bin/python",
+        "python.typeChecking": "basic",
+        "terminal.integrated.env.linux": {
+          "PATH": "/home/vscode/.rye/shims:${env:PATH}"
+        }
+      }
+    }
   }
 
   // Features to add to the dev container. More info: https://containers.dev/features.

.github/workflows/ci.yml

@@ -16,17 +16,28 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: '18'
+      - name: Install Rye
+        run: |
+          curl -sSf https://rye-up.com/get | bash
+          echo "$HOME/.rye/shims" >> $GITHUB_PATH
+        env:
+          RYE_VERSION: 0.24.0
+          RYE_INSTALL_OPTION: '--yes'
 
       - name: Install dependencies
         run: |
-          yarn install
+          rye sync --all-features
+
+      - name: Run ruff
+        run: |
+          rye run check:ruff
+
+      - name: Run type checking
+        run: |
+          rye run typecheck
 
-      - name: Check types
+      - name: Ensure importable
         run: |
-          yarn build
+          rye run python -c 'import case_filing_api'
 
   

.github/workflows/publish-pypi.yml

@@ -0,0 +1,31 @@
+# This workflow is triggered when a GitHub release is created.
+# It can also be run manually to re-publish to PyPI in case it failed for some reason.
+# You can run this workflow by navigating to https://www.github.com/vvonchain/case-filing-api/actions/workflows/publish-pypi.yml
+name: Publish PyPI
+on:
+  workflow_dispatch:
+
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Rye
+        run: |
+          curl -sSf https://rye-up.com/get | bash
+          echo "$HOME/.rye/shims" >> $GITHUB_PATH
+        env:
+          RYE_VERSION: 0.24.0
+          RYE_INSTALL_OPTION: "--yes"
+
+      - name: Publish to PyPI
+        run: |
+          bash ./bin/publish-pypi
+        env:
+          PYPI_TOKEN: ${{ secrets.CASE_FILING_API_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.github/workflows/release-doctor.yml

@@ -16,4 +16,4 @@ jobs:
         run: |
           bash ./bin/check-release-environment
         env:
-          NPM_TOKEN: ${{ secrets.CASE_FILING_API_NPM_TOKEN || secrets.NPM_TOKEN }}
+          PYPI_TOKEN: ${{ secrets.CASE_FILING_API_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.gitignore

@@ -1,8 +1,14 @@
-node_modules
-yarn-error.log
-codegen.log
+.vscode
+_dev
+
+__pycache__
+.mypy_cache
+
 dist
-/deno
-/*.tgz
-.idea/
 
+.venv
+.idea
+
+.env
+.envrc
+codegen.log

.python-version

@@ -0,0 +1 @@
+3.9.18

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
   ".": "0.0.1-alpha.0"
-}
+}

CONTRIBUTING.md

@@ -1,38 +1,55 @@
 ## Setting up the environment
 
-This repository uses [`yarn@v1`](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable).
-Other package managers may work but are not officially supported for development.
+### With Rye
 
-To set up the repository, run:
+We use [Rye](https://rye-up.com/) to manage dependencies so we highly recommend [installing it](https://rye-up.com/guide/installation/) as it will automatically provision a Python environment with the expected Python version.
 
-```bash
-yarn
-yarn build
+After installing Rye, you'll just have to run this command:
+
+```sh
+$ rye sync --all-features
 ```
 
-This will install all the required dependencies and build output files to `dist/`.
+You can then run scripts using `rye run python script.py` or by activating the virtual environment:
+
+```sh
+$ rye shell
+# or manually activate - https://docs.python.org/3/library/venv.html#how-venvs-work
+$ source .venv/bin/activate
+
+# now you can omit the `rye run` prefix
+$ python script.py
+```
+
+### Without Rye
+
+Alternatively if you don't want to install `Rye`, you can stick with the standard `pip` setup by ensuring you have the Python version specified in `.python-version`, create a virtual environment however you desire and then install dependencies using this command:
+
+```sh
+$ pip install -r requirements-dev.lock
+```
 
 ## Modifying/Adding code
 
 Most of the SDK is generated code, and any modified code will be overridden on the next generation. The
-`src/lib/` and `examples/` directories are exceptions and will never be overridden.
+`src/case_filing_api/lib/` and `examples/` directories are exceptions and will never be overridden.
 
 ## Adding and running examples
 
 All files in the `examples/` directory are not modified by the Stainless generator and can be freely edited or
 added to.
 
 ```bash
-// add an example to examples/<your-example>.ts
+# add an example to examples/<your-example>.py
 
-#!/usr/bin/env -S npm run tsn -T
+#!/usr/bin/env -S rye run python
 …
 ```
 
 ```
-chmod +x examples/<your-example>.ts
+chmod +x examples/<your-example>.py
 # run the example against your api
-yarn tsn -T examples/<your-example>.ts
+./examples/<your-example>.py
 ```
 
 ## Using the repository from source
@@ -42,66 +59,67 @@ If you’d like to use the repository from source, you can either install from g
 To install via git:
 
 ```bash
-npm install git+ssh://[email protected]:vvonchain/case-filing-api.git
+pip install git+ssh://[email protected]/vvonchain/case-filing-api.git
 ```
 
-Alternatively, to link a local copy of the repo:
+Alternatively, you can build from source and install the wheel file:
+
+Building this package will create two files in the `dist/` directory, a `.tar.gz` containing the source files and a `.whl` that can be used to install the package efficiently.
+
+To create a distributable version of the library, all you have to do is run this command:
 
 ```bash
-# Clone
-git clone https://www.github.com/vvonchain/case-filing-api
-cd case-filing-api
-
-# With yarn
-yarn link
-cd ../my-package
-yarn link case-filing-api
-
-# With pnpm
-pnpm link --global
-cd ../my-package
-pnpm link -—global case-filing-api
+rye build
+# or
+python -m build
+```
+
+Then to install:
+
+```sh
+pip install ./path-to-wheel-file.whl
 ```
 
 ## Running tests
 
 Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
 
 ```bash
+# you will need npm installed
 npx prism mock path/to/your/openapi.yml
 ```
 
 ```bash
-yarn run test
+rye run pytest
 ```
 
 ## Linting and formatting
 
-This repository uses [prettier](https://www.npmjs.com/package/prettier) and
-[eslint](https://www.npmjs.com/package/eslint) to format the code in the repository.
+This repository uses [ruff](https://github.com/astral-sh/ruff) and
+[black](https://github.com/psf/black) to format the code in the repository.
 
 To lint:
 
 ```bash
-yarn lint
+rye run lint
 ```
 
-To format and fix all lint issues automatically:
+To format and fix all ruff issues automatically:
 
 ```bash
-yarn fix
+rye run format
 ```
 
 ## Publishing and releases
 
-Changes made to this repository via the automated release PR pipeline should publish to npm automatically. If
+Changes made to this repository via the automated release PR pipeline should publish to PyPI automatically. If
 the changes aren't made through the automated pipeline, you may want to make releases manually.
 
 ### Publish with a GitHub workflow
 
-You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/vvonchain/case-filing-api/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
+You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/vvonchain/case-filing-api/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
 
 ### Publish manually
 
-If you need to manually release a package, you can run the `bin/publish-npm` script with an `NPM_TOKEN` set on
+If you need to manually release a package, you can run the `bin/publish-pypi` script with a `PYPI_TOKEN` set on
 the environment.