update

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

.github/dependabot.yml

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

.github/workflows/build-test.yml

@@ -29,21 +29,35 @@ 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
         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
+          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
-          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+          poetry run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+      - name: Run pytest
+        shell: bash
+        run: |
+          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@v2
+        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,68 @@
+name: generate docs
+permissions:
+  contents: write
+on:
+  push:
+    branches: main
+    paths:
+      - docs/conf.py
+      - '**.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
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        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/make-release.yml

@@ -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}}

.gitignore

@@ -20,4 +20,6 @@ dmypy.json
 .idea/
 
 /coverage.xml
-/.coverage
+/.coverage
+
+poetry.lock

Makefile

@@ -5,20 +5,28 @@ 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
 	docker run --rm -i $(DOCKER_FLAGS) \
 		--name python-generator \
-		-v $(CURDIR):/usr/src \
-		--workdir /usr/src \
+		-v $(CURDIR):/usr/kittycad \
+		--workdir /usr \
 		$(DOCKER_IMAGE_NAME) openapi-python-client update \
 			--url https://api.kittycad.io \
-			--config /usr/src/config.yml
+			--config /usr/kittycad/config.yml
 
 .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

@@ -5,6 +5,10 @@ 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
 
 You can trigger a build with the GitHub action to generate the client. This will
@@ -22,3 +26,44 @@ $ 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)
+```

docs/api/kittycad.AuthenticatedClient.rst

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,27 @@
+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

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

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

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

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

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

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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,6 @@
+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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

docs/api/kittycad.client.AuthenticatedClient.rst

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,27 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,17 @@
+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

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

docs/conf.py

@@ -0,0 +1,113 @@
+# 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
+
+# -- 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 os
+import sys
+
+
+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'
+copyright = 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:
+    parsed_toml = toml.load(f)
+    version = parsed_toml['tool']['poetry']['version']
+    version = 'v'+version
+
+release = version
+
+
+# -- 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 = [
+    'sphinx.ext.autodoc',
+    'sphinx_autodoc_typehints',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.linkcode',
+    'sphinx_automodapi.automodapi',
+    'sphinx_rtd_theme'
+]
+
+numpydoc_show_class_members = False
+
+automodapi_inheritance_diagram = 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 = [
+]
+
+# 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 = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+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),
+}
+
+# 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: e70151257d05c54cbec2f82169462e1b
+tags: 645f666f9bcd5a90fca523b33c5a78b7