Update api spec (#458)

* YOYO NEW API SPEC!

* I have generated the latest API!

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

.dockerignore

@@ -0,0 +1 @@
+.venv

.gitattributes

@@ -0,0 +1 @@
+docs/html/.doctrees/environment.pickle filter=lfs diff=lfs merge=lfs -text

.github/dependabot.yml

@@ -1,15 +1,96 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# DO NOT EDIT THIS FILE. This dependabot file was generated 
+# by https://github.com/KittyCAD/ciso Changes to this file should be addressed in 
+# the ciso repository.
 
 version: 2
 updates:
-  - package-ecosystem: "pip" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "github-actions" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "daily"
+- package-ecosystem: github-actions
+  directory: /
+  schedule:
+    interval: weekly
+    day: monday
+    time: '03:00'
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 5
+  groups:
+    security:
+      applies-to: security-updates
+      update-types:
+      - major
+      - minor
+      - patch
+    patch:
+      applies-to: version-updates
+      update-types:
+      - patch
+    major:
+      applies-to: version-updates
+      update-types:
+      - major
+    minor:
+      applies-to: version-updates
+      update-types:
+      - minor
+      - patch
+- package-ecosystem: pip
+  directory: /
+  schedule:
+    interval: weekly
+    day: monday
+    time: '03:00'
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 5
+  reviewers:
+  - greg-kcio
+  - jessfraz
+  groups:
+    security:
+      applies-to: security-updates
+      update-types:
+      - major
+      - minor
+      - patch
+    patch:
+      applies-to: version-updates
+      update-types:
+      - patch
+    major:
+      applies-to: version-updates
+      update-types:
+      - major
+    minor:
+      applies-to: version-updates
+      update-types:
+      - minor
+      - patch
+- package-ecosystem: docker
+  directory: /
+  schedule:
+    interval: weekly
+    day: monday
+    time: '03:00'
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 5
+  reviewers:
+  - greg-kcio
+  - jessfraz
+  groups:
+    security:
+      applies-to: security-updates
+      update-types:
+      - major
+      - minor
+      - patch
+    patch:
+      applies-to: version-updates
+      update-types:
+      - patch
+    major:
+      applies-to: version-updates
+      update-types:
+      - major
+    minor:
+      applies-to: version-updates
+      update-types:
+      - minor
+      - patch

.github/workflows/black.yml

@@ -1,38 +0,0 @@
-name: Black
-on:
-  push:
-    branches: main
-    paths:
-      - '**.py'
-      - .github/workflows/black.yml
-      - 'pyproject.toml'
-  pull_request:
-    paths:
-      - '**.py'
-      - .github/workflows/black.yml
-      - 'pyproject.toml'
-jobs:
-  black:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v4
-
-      # Installation instructions are from: https://python-poetry.org/docs/
-      - name: Install dependencies
-        shell: bash
-        run: |
-          pip install \
-          poetry
-
-      - name: Build
-        shell: bash
-        run: |
-          poetry install
-          poetry build
-
-      - name: Run black
-        shell: bash
-        run: |
-          poetry run black --check --diff .

.github/workflows/build-test.yml

@@ -6,27 +6,30 @@ on:
       - '**.py'
       - .github/workflows/build-test.yml
       - 'pyproject.toml'
+      - 'poetry.lock'
       - 'spec.json'
   pull_request:
     paths:
       - '**.py'
       - .github/workflows/build-test.yml
       - 'pyproject.toml'
+      - 'poetry.lock'
       - 'spec.json'
+  workflow_dispatch:
+    inputs:
 jobs:
   build-test:
 
     runs-on: ubuntu-latest
     strategy:
-      matrix:
-        python-version: [3.8, 3.9]
+      fail-fast: false
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: 3.9
 
       # Installation instructions are from: https://python-poetry.org/docs/
       - name: Install dependencies
@@ -49,7 +52,7 @@ jobs:
           KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true

.github/workflows/generate-docs.yml

@@ -15,9 +15,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.x
 
@@ -40,12 +40,13 @@ jobs:
         shell: bash
         run: |
           rm -rf docs/html
+          rm -rf docs/_autosummary
           poetry install
           poetry run sphinx-build -b html docs/ docs/html/
 
       - name: Check for modified files
         id: git-check
-        run: echo ::set-output name=modified::$(if git diff-index --ignore-submodules --quiet HEAD --; then echo "false"; else echo "true"; fi)
+        run: echo "modified=$(if [[ -z $(git status --porcelain --untracked-files=no --ignore-submodules) ]]; then echo "false"; else echo "true"; fi)" >> "$GITHUB_OUTPUT"
 
       - name: Commit changes, if any
         if: steps.git-check.outputs.modified == 'true'

.github/workflows/generate.yml

@@ -16,7 +16,7 @@ jobs:
     if: ${{ github.event.pull_request.head.repo.full_name == github.repository }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.ref }}
       - name: Run generate
@@ -28,7 +28,7 @@ jobs:
 
       - name: Check for modified files
         id: git-check
-        run: echo ::set-output name=modified::$(if git diff-index --ignore-submodules --quiet HEAD --; then echo "false"; else echo "true"; fi)
+        run: echo "modified=$(if [[ -z $(git status --porcelain --untracked-files=no --ignore-submodules) ]]; then echo "false"; else echo "true"; fi)" >> "$GITHUB_OUTPUT"
 
       - name: Commit changes, if any
         if: steps.git-check.outputs.modified == 'true'

.github/workflows/make-release.yml

@@ -2,14 +2,16 @@ on:
   push:
     tags:
       - v*
+permissions:
+  contents: write
 name: make-release
 jobs:
   makerelease:
     name: make-release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.x'
       # Installation instructions are from: https://python-poetry.org/docs/
@@ -28,4 +30,4 @@ jobs:
       # TODO: generate a nice little doc for the release text like we do for the
       # cli repo.
       - name: Create a Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2

.github/workflows/mypy.yml

@@ -0,0 +1,38 @@
+name: mypy
+on:
+  push:
+    branches: main
+    paths:
+      - '**.py'
+      - .github/workflows/mypy.yml
+      - 'pyproject.toml'
+  pull_request:
+    paths:
+      - '**.py'
+      - .github/workflows/mypy.yml
+      - 'pyproject.toml'
+jobs:
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+
+      - name: Build
+        shell: bash
+        run: |
+          poetry install
+          poetry build
+
+      - name: Run mypy
+        shell: bash
+        run: |
+          poetry run mypy .

.github/workflows/ruff.yml

@@ -1,4 +1,4 @@
-name: Ruff
+name: ruff
 on:
   push:
     branches: main
@@ -15,5 +15,25 @@ jobs:
   ruff:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: chartboost/ruff-action@v1
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+  
+      - name: Build
+        shell: bash
+        run: |
+          poetry install
+          poetry build
+
+      - name: Run ruff
+        shell: bash
+        run: |
+          poetry run ruff check --output-format=github .
+          poetry run ruff format --check

.github/workflows/update-spec-for-docs.yml

@@ -15,11 +15,20 @@ jobs:
     name: update-spec
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/create-github-app-token@v2
+        id: app-token
+        with:
+          # required
+          app-id: ${{ secrets.GH_ORG_APP_ID }}
+          private-key: ${{ secrets.GH_ORG_APP_PRIVATE_KEY }}
+          owner: ${{ github.repository_owner }}
+      - uses: actions/checkout@v4
       - name: make generate
         shell: bash
         run: |
           make generate
+        env:
+          KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
       # Ensure no files changed.
       - name: Ensure no files changed
         shell: bash
@@ -32,11 +41,11 @@ jobs:
             echo "No files changed, proceeding";
           fi
       # Checkout the docs repo since we will want to update the files there.
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           repository: 'kittycad/website'
           path: 'docs'
-          token: ${{secrets.PAT_GITHUB}}
+          token: ${{ steps.app-token.outputs.token }}
       - name: move spec to docs
         shell: bash
         run: |
@@ -58,8 +67,11 @@ jobs:
           gh pr create --title "Update lang spec docs for python" \
               --body "Updating the generated docs for python" \
               --head "$NEW_BRANCH" \
+              --reviewer jessfraz \
+              --reviewer irev-dev \
+              --reviewer franknoirot \
               --base main || true
         env:
-          GITHUB_TOKEN: ${{secrets.PAT_GITHUB}}
+          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
 
 

.gitignore

@@ -10,6 +10,7 @@ dist/
 # Environments
 .env
 .venv
+venv
 
 # mypy
 .mypy_cache/
@@ -19,13 +20,17 @@ dmypy.json
 # JetBrains
 .idea/
 
+# VS code
+.vscode/
+
 /coverage.xml
 /.coverage
 
-poetry.lock
 testing
 
 # Sphinx documentation
 docs/_build/
 docs/_autosummary/
 docs/html/_sources/
+
+snapshot.png

CODEOWNERS

@@ -0,0 +1,2 @@
+# CODEOWNERS migrated from dependabot reviewers
+*       @jessfraz @maxammann @iterion

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.9
+FROM python:3.13
 
 RUN pip install \
 	poetry

README.md

@@ -1,18 +1,16 @@
-![image](https://user-images.githubusercontent.com/19377312/165883233-3bdbc9fb-ddf9-4173-8cf2-d1b70ab7127d.png)
-
 # kittycad.py
 
 The Python API client for KittyCAD.
 
 - [PyPI](https://pypi.org/project/kittycad/)
-- [Python docs](https://python.api.docs.kittycad.io/)
-- [KittyCAD API Docs](https://docs.kittycad.io/?lang=python)
+- [Python docs](https://python.api.docs.zoo.dev/)
+- [KittyCAD API Docs](https://zoo.dev/docs/api?lang=python)
 
 ## Generating
 
 You can trigger a build with the GitHub action to generate the client. This will
 automatically update the client to the latest version based on the spec hosted
-at [api.kittycad.io](https://api.kittycad.io/).
+at [api.zoo.dev](https://api.zoo.dev/).
 
 Alternatively, if you wish to generate the client locally, make sure you have
 [Docker installed](https://docs.docker.com/get-docker/) and run:

docs/conf.py

@@ -126,6 +126,7 @@ intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
 }
 
+
 # This is a function linkcode_resolve(domain, info), which should return the URL
 # to source code corresponding to the object in given domain with given information.
 # FROM: https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html
@@ -135,7 +136,7 @@ def linkcode_resolve(domain, info):
     if not info["module"]:
         return None
     filename = info["module"].replace(".", "/")
-    return "https://github.com/kittycad/kittycad.py/%s.py" % filename
+    return f"https://github.com/kittycad/kittycad.py/{filename}.py"
 
 
 # Spell checker.
@@ -143,7 +144,7 @@ try:
     import enchant  # noqa # pylint: disable=unused-import
 except ImportError as ex:
     print(
-        "enchant module import failed:\n" "{0}\n" "Spell checking disabled.".format(ex),
+        f"enchant module import failed:\n{ex}\nSpell checking disabled.",
         file=sys.stderr,
     )
 else:

docs/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: c4d9784d0d7faa3c4bde65c9f259c1f0
+config: 5e5b8f9718f685a9008b6d11b745652b
 tags: 645f666f9bcd5a90fca523b33c5a78b7