Update api spec (#107)

* YOYO NEW API SPEC!

* I have generated the latest API!

---------

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

.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

@@ -19,7 +19,7 @@ jobs:
     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
@@ -41,14 +41,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: |

.github/workflows/generate.yml

@@ -23,6 +23,8 @@ jobs:
         shell: bash
         run: |
           make generate
+        env:
+          KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
 
       - name: Check for modified files
         id: git-check

.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

@@ -20,6 +20,8 @@ jobs:
         shell: bash
         run: |
           make generate
+        env:
+          KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
       # Ensure no files changed.
       - name: Ensure no files changed
         shell: bash

.gitignore

@@ -24,3 +24,8 @@ dmypy.json
 
 poetry.lock
 testing
+
+# Sphinx documentation
+docs/_build/
+docs/_autosummary/
+docs/html/_sources/

Makefile

@@ -13,6 +13,7 @@ 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):/home/user/src \
 		--workdir /home/user/src \

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 --------------------------------------------------------------
-
-# 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 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'))
-
+sys.path.append(os.path.abspath("../kittycad"))
 
 # -- Project information -----------------------------------------------------
 
-project = 'kittycad'
-author = 'KittyCAD Team Members'
-copyright = author
+project = "kittycad"
+author = "KittyCAD Team Members"
+year = datetime.date.today().year
+copyright = str(year) + ", " + author
 
-# The full version, including alpha/beta/rc tags
-# Get the version from the poetry file.
-import toml
-
-with open(os.path.abspath('../pyproject.toml'), 'r') as f:
+with open(os.path.abspath("../pyproject.toml"), "r") as f:
     parsed_toml = toml.load(f)
-    version = parsed_toml['tool']['poetry']['version']
-    version = 'v'+version
+    version = parsed_toml["tool"]["poetry"]["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',
-    'sphinx_autodoc_typehints',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.linkcode',
-    'sphinx_automodapi.automodapi',
-    'sphinx_rtd_theme'
+    "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
 
-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,61 @@ 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"
+
+# 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 configuration.
-# FROM: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx
 intersphinx_mapping = {
-    'python': ('https://python.readthedocs.io/en/latest/', None),
+    "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 +142,10 @@ def linkcode_resolve(domain, info):
 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)
+    print(
+        "enchant module import failed:\n" "{0}\n" "Spell checking disabled.".format(ex),
+        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: 4b9674dd05f426997ea93164c4dd9b06
+config: ede22824c55a9b876f5b98e3bdf43da4
 tags: 645f666f9bcd5a90fca523b33c5a78b7