I HAVE GENERATED YOUR NEW DOCS!

* add websockets lib, bump version

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

* use template

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

* fixes

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

@@ -9,3 +9,7 @@ updates:
     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 }}
 
@@ -37,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: |
@@ -53,7 +49,7 @@ jobs:
           KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true

.github/workflows/generate-docs.yml

@@ -9,21 +9,15 @@ on:
       - '**.rst'
       - '**.py'
       - .github/workflows/generate-docs.yml
-  pull_request:
-    paths:
-      - docs/conf.py
-      - '**.rst'
-      - '**.py'
-      - .github/workflows/generate-docs.yml
 jobs:
   generate-docs:
 
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: 3.x
 

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

.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

@@ -23,3 +23,9 @@ dmypy.json
 /.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

@@ -10,14 +10,25 @@ endif
 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/kittycad \
-		--workdir /usr \
-		$(DOCKER_IMAGE_NAME) openapi-python-client update \
-			--url https://api.kittycad.io \
-			--config /usr/kittycad/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:

README.md

@@ -1,10 +1,9 @@
+![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)
@@ -26,44 +25,3 @@ $ make generate
 
 Please do not change the code directly since it is generated. PRs that change
 the code directly will be automatically closed by a bot.
-
-## Usage
-First, create an authenticated client:
-
-```python
-from kittycad import AuthenticatedClient
-
-client = AuthenticatedClient(token="your_token")
-```
-
-If you want to use the environment variable `KITTYCAD_API_TOKEN` to do
-authentication and not pass one to the client, do the following:
-
-```python
-from kittycad import AuthenticatedClientFromEnv
-
-client = AuthenticatedClientFromEnv()
-```
-
-Now call your endpoint and use your models:
-
-```python
-from kittycad.models import AuthSession
-from kittycad.api.meta import meta_debug_session
-from kittycad.types import Response
-
-session: AuthSession = meta_debug_session.sync(client=client)
-# or if you need more info (e.g. status_code)
-response: Response[AuthSession] = meta_debug_session.sync_detailed(client=client)
-```
-
-Or do the same thing with an async version:
-
-```python
-from kittycad.models import AuthSession
-from kittycad.api.meta import meta_debug_session
-from kittycad.types import Response
-
-session: AuthSession = await meta_debug_session.asyncio(client=client)
-response: Response[AuthSession] = await meta_debug_session.asyncio_detailed(client=client)
-```

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/api/kittycad.AuthenticatedClient.rst

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

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.api.file.file_conversion_by_id.asyncio.rst

@@ -1,6 +0,0 @@
-asyncio
-=======
-
-.. currentmodule:: kittycad.api.file.file_conversion_by_id
-
-.. autofunction:: asyncio

docs/api/kittycad.api.file.file_conversion_by_id.asyncio_detailed.rst

@@ -1,6 +0,0 @@
-asyncio_detailed
-================
-
-.. currentmodule:: kittycad.api.file.file_conversion_by_id
-
-.. autofunction:: asyncio_detailed

docs/api/kittycad.api.file.file_conversion_by_id.sync.rst

@@ -1,6 +0,0 @@
-sync
-====
-
-.. currentmodule:: kittycad.api.file.file_conversion_by_id
-
-.. autofunction:: sync

docs/api/kittycad.api.file.file_conversion_by_id.sync_detailed.rst

@@ -1,6 +0,0 @@
-sync_detailed
-=============
-
-.. currentmodule:: kittycad.api.file.file_conversion_by_id
-
-.. autofunction:: sync_detailed

docs/api/kittycad.api.file.file_conversion_by_id_with_base64_helper.asyncio.rst

@@ -1,6 +0,0 @@
-asyncio
-=======
-
-.. currentmodule:: kittycad.api.file.file_conversion_by_id_with_base64_helper
-
-.. autofunction:: asyncio

docs/api/kittycad.api.file.file_conversion_by_id_with_base64_helper.sync.rst

@@ -1,6 +0,0 @@
-sync
-====
-
-.. currentmodule:: kittycad.api.file.file_conversion_by_id_with_base64_helper
-
-.. autofunction:: sync

docs/api/kittycad.api.file.file_convert.asyncio.rst

@@ -1,6 +0,0 @@
-asyncio
-=======
-
-.. currentmodule:: kittycad.api.file.file_convert
-
-.. autofunction:: asyncio

docs/api/kittycad.api.file.file_convert.asyncio_detailed.rst

@@ -1,6 +0,0 @@
-asyncio_detailed
-================
-
-.. currentmodule:: kittycad.api.file.file_convert
-
-.. autofunction:: asyncio_detailed

docs/api/kittycad.api.file.file_convert.sync.rst

@@ -1,6 +0,0 @@
-sync
-====
-
-.. currentmodule:: kittycad.api.file.file_convert
-
-.. autofunction:: sync

docs/api/kittycad.api.file.file_convert.sync_detailed.rst

@@ -1,6 +0,0 @@
-sync_detailed
-=============
-
-.. currentmodule:: kittycad.api.file.file_convert
-
-.. autofunction:: sync_detailed

docs/api/kittycad.api.file.file_convert_with_base64_helper.asyncio.rst

@@ -1,6 +0,0 @@
-asyncio
-=======
-
-.. currentmodule:: kittycad.api.file.file_convert_with_base64_helper
-
-.. autofunction:: asyncio

docs/api/kittycad.api.file.file_convert_with_base64_helper.sync.rst

@@ -1,6 +0,0 @@
-sync
-====
-
-.. currentmodule:: kittycad.api.file.file_convert_with_base64_helper
-
-.. autofunction:: sync

docs/api/kittycad.api.meta.meta_debug_instance.asyncio.rst

@@ -1,6 +0,0 @@
-asyncio
-=======
-
-.. currentmodule:: kittycad.api.meta.meta_debug_instance
-
-.. autofunction:: asyncio

docs/api/kittycad.api.meta.meta_debug_instance.asyncio_detailed.rst

@@ -1,6 +0,0 @@
-asyncio_detailed
-================
-
-.. currentmodule:: kittycad.api.meta.meta_debug_instance
-
-.. autofunction:: asyncio_detailed

docs/api/kittycad.api.meta.meta_debug_instance.sync.rst

@@ -1,6 +0,0 @@
-sync
-====
-
-.. currentmodule:: kittycad.api.meta.meta_debug_instance
-
-.. autofunction:: sync

docs/api/kittycad.api.meta.meta_debug_instance.sync_detailed.rst

@@ -1,6 +0,0 @@
-sync_detailed
-=============
-
-.. currentmodule:: kittycad.api.meta.meta_debug_instance
-
-.. autofunction:: sync_detailed

docs/api/kittycad.api.meta.meta_debug_session.asyncio.rst

@@ -1,6 +0,0 @@
-asyncio
-=======
-
-.. currentmodule:: kittycad.api.meta.meta_debug_session
-
-.. autofunction:: asyncio

docs/api/kittycad.api.meta.meta_debug_session.asyncio_detailed.rst

@@ -1,6 +0,0 @@
-asyncio_detailed
-================
-
-.. currentmodule:: kittycad.api.meta.meta_debug_session
-
-.. autofunction:: asyncio_detailed

docs/api/kittycad.api.meta.meta_debug_session.sync.rst

@@ -1,6 +0,0 @@
-sync
-====
-
-.. currentmodule:: kittycad.api.meta.meta_debug_session
-
-.. autofunction:: sync

docs/api/kittycad.api.meta.meta_debug_session.sync_detailed.rst

@@ -1,6 +0,0 @@
-sync_detailed
-=============
-
-.. currentmodule:: kittycad.api.meta.meta_debug_session
-
-.. autofunction:: sync_detailed

docs/api/kittycad.api.meta.ping.asyncio.rst

@@ -1,6 +0,0 @@
-asyncio
-=======
-
-.. currentmodule:: kittycad.api.meta.ping
-
-.. autofunction:: asyncio

docs/api/kittycad.api.meta.ping.asyncio_detailed.rst

@@ -1,6 +0,0 @@
-asyncio_detailed
-================
-
-.. currentmodule:: kittycad.api.meta.ping
-
-.. autofunction:: asyncio_detailed

docs/api/kittycad.api.meta.ping.sync.rst

@@ -1,6 +0,0 @@
-sync
-====
-
-.. currentmodule:: kittycad.api.meta.ping
-
-.. autofunction:: sync

docs/api/kittycad.api.meta.ping.sync_detailed.rst

@@ -1,6 +0,0 @@
-sync_detailed
-=============
-
-.. currentmodule:: kittycad.api.meta.ping
-
-.. autofunction:: sync_detailed

docs/api/kittycad.client.AuthenticatedClient.rst

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

docs/api/kittycad.client.AuthenticatedClientFromEnv.rst

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

docs/api/kittycad.client.Client.rst

@@ -1,27 +0,0 @@
-Client
-======
-
-.. currentmodule:: kittycad.client
-
-.. 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.models.AuthSession.rst

@@ -1,29 +0,0 @@
-AuthSession
-===========
-
-.. currentmodule:: kittycad.models
-
-.. autoclass:: AuthSession
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~AuthSession.additional_keys
-
-   .. rubric:: Methods Summary
-
-   .. autosummary::
-
-      ~AuthSession.from_dict
-      ~AuthSession.to_dict
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: additional_keys
-
-   .. rubric:: Methods Documentation
-
-   .. automethod:: from_dict
-   .. automethod:: to_dict

docs/api/kittycad.models.Environment.rst

@@ -1,21 +0,0 @@
-Environment
-===========
-
-.. currentmodule:: kittycad.models
-
-.. autoclass:: Environment
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~Environment.DEVELOPMENT
-      ~Environment.PREVIEW
-      ~Environment.PRODUCTION
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: DEVELOPMENT
-   .. autoattribute:: PREVIEW
-   .. autoattribute:: PRODUCTION

docs/api/kittycad.models.ErrorMessage.rst

@@ -1,29 +0,0 @@
-ErrorMessage
-============
-
-.. currentmodule:: kittycad.models
-
-.. autoclass:: ErrorMessage
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~ErrorMessage.additional_keys
-
-   .. rubric:: Methods Summary
-
-   .. autosummary::
-
-      ~ErrorMessage.from_dict
-      ~ErrorMessage.to_dict
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: additional_keys
-
-   .. rubric:: Methods Documentation
-
-   .. automethod:: from_dict
-   .. automethod:: to_dict

docs/api/kittycad.models.FileConversion.rst

@@ -1,29 +0,0 @@
-FileConversion
-==============
-
-.. currentmodule:: kittycad.models
-
-.. autoclass:: FileConversion
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~FileConversion.additional_keys
-
-   .. rubric:: Methods Summary
-
-   .. autosummary::
-
-      ~FileConversion.from_dict
-      ~FileConversion.to_dict
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: additional_keys
-
-   .. rubric:: Methods Documentation
-
-   .. automethod:: from_dict
-   .. automethod:: to_dict

docs/api/kittycad.models.FileConversionStatus.rst

@@ -1,25 +0,0 @@
-FileConversionStatus
-====================
-
-.. currentmodule:: kittycad.models
-
-.. autoclass:: FileConversionStatus
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~FileConversionStatus.COMPLETED
-      ~FileConversionStatus.FAILED
-      ~FileConversionStatus.IN_PROGRESS
-      ~FileConversionStatus.QUEUED
-      ~FileConversionStatus.UPLOADED
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: COMPLETED
-   .. autoattribute:: FAILED
-   .. autoattribute:: IN_PROGRESS
-   .. autoattribute:: QUEUED
-   .. autoattribute:: UPLOADED

docs/api/kittycad.models.InstanceMetadata.rst

@@ -1,29 +0,0 @@
-InstanceMetadata
-================
-
-.. currentmodule:: kittycad.models
-
-.. autoclass:: InstanceMetadata
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~InstanceMetadata.additional_keys
-
-   .. rubric:: Methods Summary
-
-   .. autosummary::
-
-      ~InstanceMetadata.from_dict
-      ~InstanceMetadata.to_dict
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: additional_keys
-
-   .. rubric:: Methods Documentation
-
-   .. automethod:: from_dict
-   .. automethod:: to_dict

docs/api/kittycad.models.Message.rst

@@ -1,29 +0,0 @@
-Message
-=======
-
-.. currentmodule:: kittycad.models
-
-.. autoclass:: Message
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~Message.additional_keys
-
-   .. rubric:: Methods Summary
-
-   .. autosummary::
-
-      ~Message.from_dict
-      ~Message.to_dict
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: additional_keys
-
-   .. rubric:: Methods Documentation
-
-   .. automethod:: from_dict
-   .. automethod:: to_dict

docs/api/kittycad.models.ValidFileTypes.rst

@@ -1,25 +0,0 @@
-ValidFileTypes
-==============
-
-.. currentmodule:: kittycad.models
-
-.. autoclass:: ValidFileTypes
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~ValidFileTypes.DWG
-      ~ValidFileTypes.DXF
-      ~ValidFileTypes.OBJ
-      ~ValidFileTypes.STEP
-      ~ValidFileTypes.STL
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: DWG
-   .. autoattribute:: DXF
-   .. autoattribute:: OBJ
-   .. autoattribute:: STEP
-   .. autoattribute:: STL

docs/api/kittycad.models.auth_session.AuthSession.rst

@@ -1,29 +0,0 @@
-AuthSession
-===========
-
-.. currentmodule:: kittycad.models.auth_session
-
-.. autoclass:: AuthSession
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~AuthSession.additional_keys
-
-   .. rubric:: Methods Summary
-
-   .. autosummary::
-
-      ~AuthSession.from_dict
-      ~AuthSession.to_dict
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: additional_keys
-
-   .. rubric:: Methods Documentation
-
-   .. automethod:: from_dict
-   .. automethod:: to_dict

docs/api/kittycad.models.environment.Environment.rst

@@ -1,21 +0,0 @@
-Environment
-===========
-
-.. currentmodule:: kittycad.models.environment
-
-.. autoclass:: Environment
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~Environment.DEVELOPMENT
-      ~Environment.PREVIEW
-      ~Environment.PRODUCTION
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: DEVELOPMENT
-   .. autoattribute:: PREVIEW
-   .. autoattribute:: PRODUCTION

docs/api/kittycad.models.error_message.ErrorMessage.rst

@@ -1,29 +0,0 @@
-ErrorMessage
-============
-
-.. currentmodule:: kittycad.models.error_message
-
-.. autoclass:: ErrorMessage
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~ErrorMessage.additional_keys
-
-   .. rubric:: Methods Summary
-
-   .. autosummary::
-
-      ~ErrorMessage.from_dict
-      ~ErrorMessage.to_dict
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: additional_keys
-
-   .. rubric:: Methods Documentation
-
-   .. automethod:: from_dict
-   .. automethod:: to_dict

docs/api/kittycad.models.file_conversion.FileConversion.rst

@@ -1,29 +0,0 @@
-FileConversion
-==============
-
-.. currentmodule:: kittycad.models.file_conversion
-
-.. autoclass:: FileConversion
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~FileConversion.additional_keys
-
-   .. rubric:: Methods Summary
-
-   .. autosummary::
-
-      ~FileConversion.from_dict
-      ~FileConversion.to_dict
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: additional_keys
-
-   .. rubric:: Methods Documentation
-
-   .. automethod:: from_dict
-   .. automethod:: to_dict

docs/api/kittycad.models.file_conversion.FileConversionStatus.rst

@@ -1,25 +0,0 @@
-FileConversionStatus
-====================
-
-.. currentmodule:: kittycad.models.file_conversion
-
-.. autoclass:: FileConversionStatus
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~FileConversionStatus.COMPLETED
-      ~FileConversionStatus.FAILED
-      ~FileConversionStatus.IN_PROGRESS
-      ~FileConversionStatus.QUEUED
-      ~FileConversionStatus.UPLOADED
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: COMPLETED
-   .. autoattribute:: FAILED
-   .. autoattribute:: IN_PROGRESS
-   .. autoattribute:: QUEUED
-   .. autoattribute:: UPLOADED

docs/api/kittycad.models.file_conversion_status.FileConversionStatus.rst

@@ -1,25 +0,0 @@
-FileConversionStatus
-====================
-
-.. currentmodule:: kittycad.models.file_conversion_status
-
-.. autoclass:: FileConversionStatus
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~FileConversionStatus.COMPLETED
-      ~FileConversionStatus.FAILED
-      ~FileConversionStatus.IN_PROGRESS
-      ~FileConversionStatus.QUEUED
-      ~FileConversionStatus.UPLOADED
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: COMPLETED
-   .. autoattribute:: FAILED
-   .. autoattribute:: IN_PROGRESS
-   .. autoattribute:: QUEUED
-   .. autoattribute:: UPLOADED

docs/api/kittycad.models.instance_metadata.InstanceMetadata.rst

@@ -1,29 +0,0 @@
-InstanceMetadata
-================
-
-.. currentmodule:: kittycad.models.instance_metadata
-
-.. autoclass:: InstanceMetadata
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~InstanceMetadata.additional_keys
-
-   .. rubric:: Methods Summary
-
-   .. autosummary::
-
-      ~InstanceMetadata.from_dict
-      ~InstanceMetadata.to_dict
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: additional_keys
-
-   .. rubric:: Methods Documentation
-
-   .. automethod:: from_dict
-   .. automethod:: to_dict

docs/api/kittycad.models.message.Message.rst

@@ -1,29 +0,0 @@
-Message
-=======
-
-.. currentmodule:: kittycad.models.message
-
-.. autoclass:: Message
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~Message.additional_keys
-
-   .. rubric:: Methods Summary
-
-   .. autosummary::
-
-      ~Message.from_dict
-      ~Message.to_dict
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: additional_keys
-
-   .. rubric:: Methods Documentation
-
-   .. automethod:: from_dict
-   .. automethod:: to_dict

docs/api/kittycad.models.valid_file_types.ValidFileTypes.rst

@@ -1,25 +0,0 @@
-ValidFileTypes
-==============
-
-.. currentmodule:: kittycad.models.valid_file_types
-
-.. autoclass:: ValidFileTypes
-   :show-inheritance:
-
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~ValidFileTypes.DWG
-      ~ValidFileTypes.DXF
-      ~ValidFileTypes.OBJ
-      ~ValidFileTypes.STEP
-      ~ValidFileTypes.STL
-
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: DWG
-   .. autoattribute:: DXF
-   .. autoattribute:: OBJ
-   .. autoattribute:: STEP
-   .. autoattribute:: STL

docs/api/kittycad.types.File.rst

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

docs/api/kittycad.types.Response.rst

@@ -1,7 +0,0 @@
-Response
-========
-
-.. currentmodule:: kittycad.types
-
-.. autoclass:: Response
-   :show-inheritance:

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,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.
-# 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),
+# 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':
+    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"
-          "{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: e70151257d05c54cbec2f82169462e1b
+config: cc6cad35e5f51712aa81bdb56800a23d
 tags: 645f666f9bcd5a90fca523b33c5a78b7