Update api spec (#93)

* YOYO NEW API SPEC!

* update

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

* fix

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

* fix

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

* I have generated the latest API!

---------

Signed-off-by: Jess Frazelle <github@jessfraz.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

.github/dependabot.yml

@@ -0,0 +1,15 @@
+# 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
+
+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"

.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@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 . generate/generate.py docs/conf.py kittycad/client_test.py kittycad/examples_test.py

.github/workflows/build-test.yml

@@ -5,22 +5,26 @@ on:
     paths:
       - '**.py'
       - .github/workflows/build-test.yml
+      - 'pyproject.toml'
+      - 'spec.json'
   pull_request:
     paths:
       - '**.py'
       - .github/workflows/build-test.yml
+      - 'pyproject.toml'
+      - 'spec.json'
 jobs:
   build-test:
 
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: [3.8, 3.9]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -29,21 +33,27 @@ jobs:
         shell: bash
         run: |
           pip install \
-          flake8 \
-          poetry \
-          pytest
+          poetry
 
       - name: Build
         shell: bash
         run: |
-          cd kittycad
+          poetry install
           poetry build
 
-      - name: Lint with flake8
+      - name: Run pytest
         shell: bash
         run: |
-          # stop the build if there are Python syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+          poetry run pytest --cov=./ --cov-report=xml kittycad
+        env:
+          KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+          flags: unittests
+          files: ${{ github.workspace }}/coverage.xml
+          verbose: true
 

.github/workflows/generate-docs.yml

@@ -0,0 +1,62 @@
+name: generate docs
+permissions:
+  contents: write
+on:
+  push:
+    branches: main
+    paths:
+      - docs/conf.py
+      - '**.rst'
+      - '**.py'
+      - .github/workflows/generate-docs.yml
+jobs:
+  generate-docs:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      # Installation instructions are from: https://python-poetry.org/docs/
+      - name: Install dependencies
+        shell: bash
+        run: |
+          sudo apt update && sudo apt install -y \
+            enchant-2 \
+            --no-install-recommends
+          pip install \
+            poetry
+
+      - name: Build
+        shell: bash
+        run: |
+          poetry build
+
+      - name: Generate the docs
+        shell: bash
+        run: |
+          rm -rf docs/html
+          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)
+
+      - name: Commit changes, if any
+        if: steps.git-check.outputs.modified == 'true'
+        run: |
+          git add .
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git remote set-url origin https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
+          git commit -am "I HAVE GENERATED YOUR NEW DOCS!" || true
+          git fetch origin
+          git rebase origin/${{github.ref_name }} || true
+          git push origin ${{github.ref_name }}
+
+

.github/workflows/generate.yml

@@ -6,6 +6,8 @@ on:
     paths:
       - 'Makefile'
       - .github/workflows/generate.yml
+      - 'spec.json'
+      - 'generate/generate.py'
   workflow_dispatch:
     inputs:
 jobs:
@@ -14,13 +16,15 @@ jobs:
     if: ${{ github.event.pull_request.head.repo.full_name == github.repository }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         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
@@ -33,5 +37,6 @@ jobs:
           git config --local user.name "github-actions[bot]"
           git remote set-url origin https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
           git fetch origin
+          git add .
           git commit -am "I have generated the latest API!" || true
           git push origin ${{github.event.pull_request.head.ref }} || true

.github/workflows/make-release.yml

@@ -8,8 +8,8 @@ jobs:
     name: make-release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
           python-version: '3.x'
       # Installation instructions are from: https://python-poetry.org/docs/
@@ -21,7 +21,6 @@ jobs:
       - name: Do the release
         shell: bash
         run: |
-          cd kittycad
           poetry publish --build \
             --username ${{secrets.PYPI_USERNAME}} \
             --password ${{secrets.PYPI_SECRET}}

.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@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 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@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 ruff
+        shell: bash
+        run: |
+          poetry run ruff check --format=github .

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

@@ -0,0 +1,67 @@
+on:
+  push:
+    tags:
+      - v*
+  pull_request:
+    paths:
+      - .github/workflows/update-spec-for-docs.yml
+  workflow_dispatch:
+name: update spec for docs
+concurrency:
+  group: docs-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  update-spec:
+    name: update-spec
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - 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 kittycad/` ]]; then
+            echo "Files changed, exiting";
+            exit 1;
+          else
+            # No changes
+            echo "No files changed, proceeding";
+          fi
+      # Checkout the docs repo since we will want to update the files there.
+      - uses: actions/checkout@v3
+        with:
+          repository: 'kittycad/website'
+          path: 'docs'
+          token: ${{secrets.PAT_GITHUB}}
+      - name: move spec to docs
+        shell: bash
+        run: |
+          rm docs/kittycad.py.patch.json || true
+          cp kittycad.py.patch.json docs/kittycad.py.patch.json
+      - name: commit the changes in the docs repo
+        shell: bash
+        run: |
+          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 PYTHON DOCS!" || exit 0
+          git fetch origin
+          git rebase origin/main || exit 0
+          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 python" \
+              --body "Updating the generated docs for python" \
+              --head "$NEW_BRANCH" \
+              --base main || true
+        env:
+          GITHUB_TOKEN: ${{secrets.PAT_GITHUB}}
+
+

.gitignore

@@ -20,4 +20,12 @@ dmypy.json
 .idea/
 
 /coverage.xml
-/.coverage
+/.coverage
+
+poetry.lock
+testing
+
+# Sphinx documentation
+docs/_build/
+docs/_autosummary/
+docs/html/_sources/

Dockerfile

@@ -1,7 +1,13 @@
-FROM python:latest
+FROM python:3.9
 
 RUN pip install \
-	openapi-python-client
+	poetry
+
+WORKDIR /home/user/src/
+
+COPY . /home/user/src/
+
+RUN poetry update && poetry install
 
 # Set the default command to bash.
 CMD ["bash"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 KittyCAD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -5,20 +5,39 @@ ifeq ($(INTERACTIVE), 1)
 	DOCKER_FLAGS += -t
 endif
 
+# For this to work, you need to install toml-cli: https://github.com/gnprice/toml-cli
+# `cargo install toml-cli`
+VERSION := $(shell toml get $(CURDIR)/pyproject.toml tool.poetry.version | jq -r .)
+
 .PHONY: generate
-generate: docker-image
+generate: docker-image ## Generate the api client.
 	docker run --rm -i $(DOCKER_FLAGS) \
 		--name python-generator \
-		-v $(CURDIR):/usr/src \
-		--workdir /usr/src \
-		$(DOCKER_IMAGE_NAME) openapi-python-client update \
-			--url https://api.kittycad.io \
-			--config /usr/src/config.yml
+		-e KITTYCAD_API_TOKEN \
+		--disable-content-trust \
+		-v $(CURDIR):/home/user/src \
+		--workdir /home/user/src \
+		$(DOCKER_IMAGE_NAME) ./generate/run.sh
+
+.PHONY: shell
+shell: docker-image ## Pop into a shell in the docker image.
+	docker run --rm -i $(DOCKER_FLAGS) \
+		--name python-generator-shell \
+		-e KITTYCAD_API_TOKEN \
+		--disable-content-trust \
+		-v $(CURDIR):/home/user/src \
+		--workdir /home/user/src \
+		$(DOCKER_IMAGE_NAME) /bin/bash
+
 
 .PHONY: docker-image
 docker-image:
 	docker build -t $(DOCKER_IMAGE_NAME) .
 
+.PHONY: tag
+tag: ## Create a new git tag to prepare to build a release.
+	git tag -sa "v$(VERSION)" -m "v$(VERSION)"
+	@echo "Run git push origin v$(VERSION) to push your new tag to GitHub and trigger a release."
 
 .PHONY: help
 help:

README.md

@@ -1,9 +1,12 @@
+![image](https://user-images.githubusercontent.com/19377312/165883233-3bdbc9fb-ddf9-4173-8cf2-d1b70ab7127d.png)
+
 # kittycad.py
 
 The Python API client for KittyCAD.
 
-This is generated from
-[openapi-generators/openapi-python-client](https://github.com/openapi-generators/openapi-python-client).
+- [PyPI](https://pypi.org/project/kittycad/)
+- [Python docs](https://python.api.docs.kittycad.io/)
+- [KittyCAD API Docs](https://docs.kittycad.io/?lang=python)
 
 ## Generating
 

config.yml

@@ -1,2 +0,0 @@
-project_name_override: kittycad
-package_name_override: kittycad

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/conf.py

@@ -0,0 +1,151 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import datetime
+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"))
+
+# -- Project information -----------------------------------------------------
+
+project = "kittycad"
+author = "KittyCAD Team Members"
+year = datetime.date.today().year
+copyright = str(year) + ", " + author
+
+with open(os.path.abspath("../pyproject.toml"), "r") as f:
+    parsed_toml = toml.load(f)
+    version = parsed_toml["tool"]["poetry"]["version"]
+    version = "v" + version
+
+
+release = version
+language = "en"
+default_role = "any"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "autoclasstoc",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.coverage",
+    "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
+
+# Add any paths that contain templates here, relative to this directory.
+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"]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom themes here, relative to this directory.
+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: List[str] = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "trac"
+
+# pygments_style = "lovelace"
+# pygments_dark_style = "one-dark"
+
+# -- 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":
+        return None
+    if not info["module"]:
+        return None
+    filename = info["module"].replace(".", "/")
+    return "https://github.com/kittycad/kittycad.py/%s.py" % filename
+
+
+# Spell checker.
+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),
+        file=sys.stderr,
+    )
+else:
+    extensions.append("sphinxcontrib.spelling")
+    spelling_show_suggestions = True

docs/html/.buildinfo

@@ -0,0 +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: cd3bba1878bfa92a239de9b4e9758963
+tags: 645f666f9bcd5a90fca523b33c5a78b7