even tighter version

Signed-off-by: Jess Frazelle <github@jessfraz.com>

.dockerignore

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

.gitattributes

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

.github/workflows/black.yml

@@ -0,0 +1,38 @@
+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@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+
+      # 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 . generate/generate.py docs/conf.py kittycad/client_test.py kittycad/examples_test.py

.github/workflows/build-test.yml

@@ -6,25 +6,29 @@ 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.7, 3.8, 3.9]
+        python-version: [3.8, 3.9]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -41,14 +45,6 @@ jobs:
           poetry install
           poetry build
 
-      - name: Lint with flake8
-        shell: bash
-        run: |
-          # stop the build if there are Python syntax errors or undefined names
-          poetry run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          #poetry run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-
       - name: Run pytest
         shell: bash
         run: |
@@ -57,7 +53,7 @@ jobs:
           KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         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,6 +40,7 @@ jobs:
         shell: bash
         run: |
           rm -rf docs/html
+          rm -rf docs/_autosummary
           poetry install
           poetry run sphinx-build -b html docs/ docs/html/
 

.github/workflows/generate.yml

@@ -16,13 +16,15 @@ 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
         shell: bash
         run: |
           make generate
+        env:
+          KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
 
       - name: Check for modified files
         id: git-check

.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/checkout@v4
-      - uses: actions/setup-python@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
+
+      # 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 mypy
+        shell: bash
+        run: |
+          poetry run mypy .

.github/workflows/ruff.yml

@@ -0,0 +1,38 @@
+name: ruff
+on:
+  push:
+    branches: main
+    paths:
+      - '**.py'
+      - .github/workflows/ruff.yml
+      - 'pyproject.toml'
+  pull_request:
+    paths:
+      - '**.py'
+      - .github/workflows/ruff.yml
+      - 'pyproject.toml'
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+
+      # 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 ruff
+        shell: bash
+        run: |
+          poetry run ruff check --output-format=github .

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

@@ -15,16 +15,25 @@ jobs:
     name: update-spec
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/create-github-app-token@v1
+        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
         run: |
-          if [[ `git status --porcelain` ]]; then
+          if [[ `git status --porcelain kittycad/` ]]; then
             echo "Files changed, exiting";
             exit 1;
           else
@@ -32,35 +41,37 @@ 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: |
-          rm docs/spec.json || true
+          rm docs/kittycad.py.patch.json || true
-          cp spec.json docs/spec.json
+          cp kittycad.py.patch.json docs/kittycad.py.patch.json
       - name: commit the changes in the docs repo
         shell: bash
         run: |
-          export VERSION=$(cat VERSION.txt);
           cd docs
           git config --local user.email "github-actions[bot]@users.noreply.github.com"
           git config --local user.name "github-actions[bot]"
           git add .
-          git commit -am "YOYO NEW SPEC DOCS ${VERSION}!" || exit 0
+          git commit -am "YOYO NEW SPEC PYTHON DOCS!" || exit 0
           git fetch origin
           git rebase origin/main || exit 0
-          export NEW_BRANCH="update-spec-${VERSION}"
+          export NEW_BRANCH="update-spec-python"
           git checkout -b "$NEW_BRANCH"
           git push -f origin "$NEW_BRANCH"
-          gh pr create --title "Update lang spec docs for ${VERSION}" \
+          gh pr create --title "Update lang spec docs for python" \
-              --body "Updating the generated docs for go lang" \
+              --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/
@@ -22,5 +23,11 @@ dmypy.json
 /coverage.xml
 /.coverage
 
-poetry.lock
 testing
+
+# Sphinx documentation
+docs/_build/
+docs/_autosummary/
+docs/html/_sources/
+
+snapshot.png

Dockerfile

@@ -3,9 +3,9 @@ FROM python:3.9
 RUN pip install \
 	poetry
 
-WORKDIR /usr/src/
+WORKDIR /home/user/src/
 
-COPY . /usr/src/
+COPY . /home/user/src/
 
 RUN poetry update && poetry install
 

Makefile

@@ -13,9 +13,10 @@ VERSION := $(shell toml get $(CURDIR)/pyproject.toml tool.poetry.version | jq -r
 generate: docker-image ## Generate the api client.
 	docker run --rm -i $(DOCKER_FLAGS) \
 		--name python-generator \
+		-e KITTYCAD_API_TOKEN \
 		--disable-content-trust \
-		-v $(CURDIR):/usr/src \
+		-v $(CURDIR):/home/user/src \
-		--workdir /usr/src \
+		--workdir /home/user/src \
 		$(DOCKER_IMAGE_NAME) ./generate/run.sh
 
 .PHONY: shell
@@ -24,8 +25,8 @@ shell: docker-image ## Pop into a shell in the docker image.
 		--name python-generator-shell \
 		-e KITTYCAD_API_TOKEN \
 		--disable-content-trust \
-		-v $(CURDIR):/usr/src \
+		-v $(CURDIR):/home/user/src \
-		--workdir /usr/src \
+		--workdir /home/user/src \
 		$(DOCKER_IMAGE_NAME) /bin/bash
 
 

README.md

@@ -3,14 +3,14 @@
 The Python API client for KittyCAD.
 
 - [PyPI](https://pypi.org/project/kittycad/)
-- [Python docs](https://python.api.docs.kittycad.io/)
+- [Python docs](https://python.api.docs.zoo.dev/)
-- [KittyCAD API Docs](https://docs.kittycad.io/?lang=python)
+- [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/_templates/custom-class-template.rst

@@ -0,0 +1,33 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+   {% for item in methods %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+

docs/_templates/custom-module-template.rst

@@ -0,0 +1,67 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :template: custom-module-template.rst
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}
+

docs/api/kittycad.Client.rst

@@ -1,27 +0,0 @@
-Client
-======
-
-.. currentmodule:: kittycad
-
-.. autoclass:: Client
-   :show-inheritance:
-
-   .. rubric:: Methods Summary
-
-   .. autosummary::
-
-      ~Client.get_cookies
-      ~Client.get_headers
-      ~Client.get_timeout
-      ~Client.with_cookies
-      ~Client.with_headers
-      ~Client.with_timeout
-
-   .. rubric:: Methods Documentation
-
-   .. automethod:: get_cookies
-   .. automethod:: get_headers
-   .. automethod:: get_timeout
-   .. automethod:: with_cookies
-   .. automethod:: with_headers
-   .. automethod:: with_timeout

docs/api/kittycad.ClientFromEnv.rst

@@ -1,17 +0,0 @@
-ClientFromEnv
-=============
-
-.. currentmodule:: kittycad
-
-.. autoclass:: ClientFromEnv
-   :show-inheritance:
-
-   .. rubric:: Methods Summary
-
-   .. autosummary::
-
-      ~ClientFromEnv.get_headers
-
-   .. rubric:: Methods Documentation
-
-   .. automethod:: get_headers

docs/conf.py

@@ -4,36 +4,39 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-# -- Path setup --------------------------------------------------------------
+import datetime
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
 import os
+import pathlib
 import sys
+from typing import List
 
+import toml
+
+# The full version, including alpha/beta/rc tags
+# Get the version from the pyproject file.
+
+ROOT = pathlib.Path(__file__).parent.parent
+PACKAGE_SRC = ROOT / "kittycad"
 
 sys.path.insert(1, os.path.dirname(os.path.abspath(__file__)))
-sys.path.append(os.path.abspath('../kittycad'))
+sys.path.append(os.path.abspath("../kittycad"))
-
 
 # -- Project information -----------------------------------------------------
 
-project = 'kittycad'
+project = "kittycad"
-author = 'KittyCAD Team Members'
+author = "KittyCAD Team Members"
-copyright = author
+year = datetime.date.today().year
+copyright = str(year) + ", " + author
 
-# The full version, including alpha/beta/rc tags
+with open(os.path.abspath("../pyproject.toml"), "r") as f:
-# Get the version from the poetry file.
-import toml
-
-with open(os.path.abspath('../pyproject.toml'), 'r') as f:
     parsed_toml = toml.load(f)
-    version = parsed_toml['tool']['poetry']['version']
+    version = parsed_toml["tool"]["poetry"]["version"]
-    version = 'v'+version
+    version = "v" + version
+
 
 release = version
+language = "en"
+default_role = "any"
 
 
 # -- General configuration ---------------------------------------------------
@@ -42,25 +45,34 @@ release = version
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
+    "autoclasstoc",
-    'sphinx_autodoc_typehints',
+    "sphinx.ext.autodoc",
-    'sphinx.ext.intersphinx',
+    "sphinx.ext.autosectionlabel",
-    'sphinx.ext.linkcode',
+    "sphinx.ext.autosummary",
-    'sphinx_automodapi.automodapi',
+    "sphinx.ext.coverage",
-    'sphinx_rtd_theme'
+    "sphinx.ext.doctest",
+    "sphinx.ext.graphviz",
+    "sphinx.ext.imgconverter",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.linkcode",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx_autodoc_typehints",
+    "sphinx_rtd_theme",
+    "sphinx_copybutton",
+    "sphinxext.opengraph",
 ]
 
 numpydoc_show_class_members = False
 
-automodapi_inheritance_diagram = False
-
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -68,35 +80,62 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [
+html_theme_path: List[str] = []
-]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+html_static_path: List[str] = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'trac'
+pygments_style = "trac"
 
-# Intersphinx configuration.
+# pygments_style = "lovelace"
-# FROM: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx
+# pygments_dark_style = "one-dark"
-intersphinx_mapping = {
+
-    'python': ('https://python.readthedocs.io/en/latest/', None),
+# -- autodoc --
+
+autodoc_default_options = {
+    "members": True,
+    "special-members": True,
+    "private-members": True,
+    "inherited-members": True,
+    "undoc-members": True,
+    "exclude-members": "__weakref__",
 }
 
+autodoc_inherit_docstrings = True
+
+# -- autosummary --
+
+autosummary_generate = True
+autoclass_content = "both"
+html_show_sourcelink = False
+set_type_checking_flag = True
+
+# -- autosectionlabel --
+
+autosectionlabel_prefix_document = True
+
+# -- intersphinx --
+
+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
 def linkcode_resolve(domain, info):
-    if domain != 'py':
+    if domain != "py":
         return None
-    if not info['module']:
+    if not info["module"]:
         return None
-    filename = info['module'].replace('.', '/')
+    filename = info["module"].replace(".", "/")
     return "https://github.com/kittycad/kittycad.py/%s.py" % filename
 
 
@@ -104,10 +143,10 @@ def linkcode_resolve(domain, info):
 try:
     import enchant  # noqa # pylint: disable=unused-import
 except ImportError as ex:
-    print("enchant module import failed:\n"
+    print(
-          "{0}\n"
+        "enchant module import failed:\n" "{0}\n" "Spell checking disabled.".format(ex),
-          "Spell checking disabled.".format(ex),
+        file=sys.stderr,
-          file=sys.stderr)
+    )
 else:
-    extensions.append('sphinxcontrib.spelling')
+    extensions.append("sphinxcontrib.spelling")
     spelling_show_suggestions = True

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: 411795e469389165777ee784bd0a4b59
+config: fd8d925af4d75d35f2f359f0a26d62ed
 tags: 645f666f9bcd5a90fca523b33c5a78b7