Compare commits
1 Commits
Author | SHA1 | Date | |
---|---|---|---|
af0d36d01f |
14
.github/workflows/build-test.yml
vendored
14
.github/workflows/build-test.yml
vendored
@ -5,26 +5,22 @@ 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.7, 3.8, 3.9]
|
||||
python-version: [3.6, 3.7, 3.8, 3.9]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v2
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v4
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
@ -47,7 +43,7 @@ jobs:
|
||||
# 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
|
||||
poetry run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
|
||||
|
||||
- name: Run pytest
|
||||
shell: bash
|
||||
@ -57,7 +53,7 @@ jobs:
|
||||
KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
|
||||
|
||||
- name: Upload coverage to Codecov
|
||||
uses: codecov/codecov-action@v3
|
||||
uses: codecov/codecov-action@v2
|
||||
with:
|
||||
token: ${{ secrets.CODECOV_TOKEN }}
|
||||
fail_ci_if_error: true
|
||||
|
10
.github/workflows/generate-docs.yml
vendored
10
.github/workflows/generate-docs.yml
vendored
@ -9,15 +9,21 @@ 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@v3
|
||||
- uses: actions/checkout@v2
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: 3.x
|
||||
|
||||
|
5
.github/workflows/generate.yml
vendored
5
.github/workflows/generate.yml
vendored
@ -6,8 +6,6 @@ on:
|
||||
paths:
|
||||
- 'Makefile'
|
||||
- .github/workflows/generate.yml
|
||||
- 'spec.json'
|
||||
- 'generate/generate.py'
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
jobs:
|
||||
@ -16,7 +14,7 @@ jobs:
|
||||
if: ${{ github.event.pull_request.head.repo.full_name == github.repository }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.ref }}
|
||||
- name: Run generate
|
||||
@ -35,6 +33,5 @@ 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
|
||||
|
4
.github/workflows/make-release.yml
vendored
4
.github/workflows/make-release.yml
vendored
@ -8,8 +8,8 @@ jobs:
|
||||
name: make-release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-python@v4
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: '3.x'
|
||||
# Installation instructions are from: https://python-poetry.org/docs/
|
||||
|
65
.github/workflows/update-spec-for-docs.yml
vendored
65
.github/workflows/update-spec-for-docs.yml
vendored
@ -1,65 +0,0 @@
|
||||
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
|
||||
# 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}}
|
||||
|
||||
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -23,4 +23,3 @@ dmypy.json
|
||||
/.coverage
|
||||
|
||||
poetry.lock
|
||||
testing
|
||||
|
10
Dockerfile
10
Dockerfile
@ -1,13 +1,7 @@
|
||||
FROM python:3.9
|
||||
FROM python:latest
|
||||
|
||||
RUN pip install \
|
||||
poetry
|
||||
|
||||
WORKDIR /usr/src/
|
||||
|
||||
COPY . /usr/src/
|
||||
|
||||
RUN poetry update && poetry install
|
||||
openapi-python-client
|
||||
|
||||
# Set the default command to bash.
|
||||
CMD ["bash"]
|
||||
|
22
Makefile
22
Makefile
@ -10,24 +10,14 @@ endif
|
||||
VERSION := $(shell toml get $(CURDIR)/pyproject.toml tool.poetry.version | jq -r .)
|
||||
|
||||
.PHONY: generate
|
||||
generate: docker-image ## Generate the api client.
|
||||
generate: docker-image
|
||||
docker run --rm -i $(DOCKER_FLAGS) \
|
||||
--name python-generator \
|
||||
--disable-content-trust \
|
||||
-v $(CURDIR):/usr/src \
|
||||
--workdir /usr/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):/usr/src \
|
||||
--workdir /usr/src \
|
||||
$(DOCKER_IMAGE_NAME) /bin/bash
|
||||
|
||||
-v $(CURDIR):/usr/kittycad \
|
||||
--workdir /usr \
|
||||
$(DOCKER_IMAGE_NAME) openapi-python-client update \
|
||||
--url https://api.kittycad.io \
|
||||
--config /usr/kittycad/config.yml
|
||||
|
||||
.PHONY: docker-image
|
||||
docker-image:
|
||||
|
46
README.md
46
README.md
@ -1,9 +1,10 @@
|
||||

|
||||
|
||||
# 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)
|
||||
@ -25,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)
|
||||
```
|
||||
|
1942
assets/testing.obj
1942
assets/testing.obj
File diff suppressed because it is too large
Load Diff
2
config.yml
Normal file
2
config.yml
Normal file
@ -0,0 +1,2 @@
|
||||
project_name_override: kittycad
|
||||
package_name_override: kittycad
|
@ -1,16 +1,16 @@
|
||||
ClientFromEnv
|
||||
=============
|
||||
AuthenticatedClient
|
||||
===================
|
||||
|
||||
.. currentmodule:: kittycad
|
||||
|
||||
.. autoclass:: ClientFromEnv
|
||||
.. autoclass:: AuthenticatedClient
|
||||
:show-inheritance:
|
||||
|
||||
.. rubric:: Methods Summary
|
||||
|
||||
.. autosummary::
|
||||
|
||||
~ClientFromEnv.get_headers
|
||||
~AuthenticatedClient.get_headers
|
||||
|
||||
.. rubric:: Methods Documentation
|
||||
|
@ -0,0 +1,6 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_conversion_by_id
|
||||
|
||||
.. autofunction:: asyncio
|
@ -0,0 +1,6 @@
|
||||
asyncio_detailed
|
||||
================
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_conversion_by_id
|
||||
|
||||
.. autofunction:: asyncio_detailed
|
@ -0,0 +1,6 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_conversion_by_id
|
||||
|
||||
.. autofunction:: sync
|
@ -0,0 +1,6 @@
|
||||
sync_detailed
|
||||
=============
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_conversion_by_id
|
||||
|
||||
.. autofunction:: sync_detailed
|
@ -0,0 +1,6 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_conversion_by_id_with_base64_helper
|
||||
|
||||
.. autofunction:: asyncio
|
@ -0,0 +1,6 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_conversion_by_id_with_base64_helper
|
||||
|
||||
.. autofunction:: sync
|
6
docs/api/kittycad.api.file.file_convert.asyncio.rst
Normal file
6
docs/api/kittycad.api.file.file_convert.asyncio.rst
Normal file
@ -0,0 +1,6 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_convert
|
||||
|
||||
.. autofunction:: asyncio
|
@ -0,0 +1,6 @@
|
||||
asyncio_detailed
|
||||
================
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_convert
|
||||
|
||||
.. autofunction:: asyncio_detailed
|
6
docs/api/kittycad.api.file.file_convert.sync.rst
Normal file
6
docs/api/kittycad.api.file.file_convert.sync.rst
Normal file
@ -0,0 +1,6 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_convert
|
||||
|
||||
.. autofunction:: sync
|
@ -0,0 +1,6 @@
|
||||
sync_detailed
|
||||
=============
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_convert
|
||||
|
||||
.. autofunction:: sync_detailed
|
@ -0,0 +1,6 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_convert_with_base64_helper
|
||||
|
||||
.. autofunction:: asyncio
|
@ -0,0 +1,6 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_convert_with_base64_helper
|
||||
|
||||
.. autofunction:: sync
|
@ -0,0 +1,6 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_instance
|
||||
|
||||
.. autofunction:: asyncio
|
@ -0,0 +1,6 @@
|
||||
asyncio_detailed
|
||||
================
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_instance
|
||||
|
||||
.. autofunction:: asyncio_detailed
|
6
docs/api/kittycad.api.meta.meta_debug_instance.sync.rst
Normal file
6
docs/api/kittycad.api.meta.meta_debug_instance.sync.rst
Normal file
@ -0,0 +1,6 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_instance
|
||||
|
||||
.. autofunction:: sync
|
@ -0,0 +1,6 @@
|
||||
sync_detailed
|
||||
=============
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_instance
|
||||
|
||||
.. autofunction:: sync_detailed
|
@ -0,0 +1,6 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_session
|
||||
|
||||
.. autofunction:: asyncio
|
@ -0,0 +1,6 @@
|
||||
asyncio_detailed
|
||||
================
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_session
|
||||
|
||||
.. autofunction:: asyncio_detailed
|
6
docs/api/kittycad.api.meta.meta_debug_session.sync.rst
Normal file
6
docs/api/kittycad.api.meta.meta_debug_session.sync.rst
Normal file
@ -0,0 +1,6 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_session
|
||||
|
||||
.. autofunction:: sync
|
@ -0,0 +1,6 @@
|
||||
sync_detailed
|
||||
=============
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_session
|
||||
|
||||
.. autofunction:: sync_detailed
|
6
docs/api/kittycad.api.meta.ping.asyncio.rst
Normal file
6
docs/api/kittycad.api.meta.ping.asyncio.rst
Normal file
@ -0,0 +1,6 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.ping
|
||||
|
||||
.. autofunction:: asyncio
|
6
docs/api/kittycad.api.meta.ping.asyncio_detailed.rst
Normal file
6
docs/api/kittycad.api.meta.ping.asyncio_detailed.rst
Normal file
@ -0,0 +1,6 @@
|
||||
asyncio_detailed
|
||||
================
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.ping
|
||||
|
||||
.. autofunction:: asyncio_detailed
|
6
docs/api/kittycad.api.meta.ping.sync.rst
Normal file
6
docs/api/kittycad.api.meta.ping.sync.rst
Normal file
@ -0,0 +1,6 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.ping
|
||||
|
||||
.. autofunction:: sync
|
6
docs/api/kittycad.api.meta.ping.sync_detailed.rst
Normal file
6
docs/api/kittycad.api.meta.ping.sync_detailed.rst
Normal file
@ -0,0 +1,6 @@
|
||||
sync_detailed
|
||||
=============
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.ping
|
||||
|
||||
.. autofunction:: sync_detailed
|
17
docs/api/kittycad.client.AuthenticatedClient.rst
Normal file
17
docs/api/kittycad.client.AuthenticatedClient.rst
Normal file
@ -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
|
17
docs/api/kittycad.client.AuthenticatedClientFromEnv.rst
Normal file
17
docs/api/kittycad.client.AuthenticatedClientFromEnv.rst
Normal file
@ -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
|
27
docs/api/kittycad.client.Client.rst
Normal file
27
docs/api/kittycad.client.Client.rst
Normal file
@ -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
|
29
docs/api/kittycad.models.AuthSession.rst
Normal file
29
docs/api/kittycad.models.AuthSession.rst
Normal file
@ -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
|
21
docs/api/kittycad.models.Environment.rst
Normal file
21
docs/api/kittycad.models.Environment.rst
Normal file
@ -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
|
29
docs/api/kittycad.models.ErrorMessage.rst
Normal file
29
docs/api/kittycad.models.ErrorMessage.rst
Normal file
@ -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
|
29
docs/api/kittycad.models.FileConversion.rst
Normal file
29
docs/api/kittycad.models.FileConversion.rst
Normal file
@ -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
|
25
docs/api/kittycad.models.FileConversionStatus.rst
Normal file
25
docs/api/kittycad.models.FileConversionStatus.rst
Normal file
@ -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
|
29
docs/api/kittycad.models.InstanceMetadata.rst
Normal file
29
docs/api/kittycad.models.InstanceMetadata.rst
Normal file
@ -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
|
29
docs/api/kittycad.models.Message.rst
Normal file
29
docs/api/kittycad.models.Message.rst
Normal file
@ -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
|
25
docs/api/kittycad.models.ValidFileTypes.rst
Normal file
25
docs/api/kittycad.models.ValidFileTypes.rst
Normal file
@ -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
|
29
docs/api/kittycad.models.auth_session.AuthSession.rst
Normal file
29
docs/api/kittycad.models.auth_session.AuthSession.rst
Normal file
@ -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
|
21
docs/api/kittycad.models.environment.Environment.rst
Normal file
21
docs/api/kittycad.models.environment.Environment.rst
Normal file
@ -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
|
29
docs/api/kittycad.models.error_message.ErrorMessage.rst
Normal file
29
docs/api/kittycad.models.error_message.ErrorMessage.rst
Normal file
@ -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
|
29
docs/api/kittycad.models.file_conversion.FileConversion.rst
Normal file
29
docs/api/kittycad.models.file_conversion.FileConversion.rst
Normal file
@ -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
|
@ -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
|
@ -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
|
@ -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
|
29
docs/api/kittycad.models.message.Message.rst
Normal file
29
docs/api/kittycad.models.message.Message.rst
Normal file
@ -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
|
25
docs/api/kittycad.models.valid_file_types.ValidFileTypes.rst
Normal file
25
docs/api/kittycad.models.valid_file_types.ValidFileTypes.rst
Normal file
@ -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
|
17
docs/api/kittycad.types.File.rst
Normal file
17
docs/api/kittycad.types.File.rst
Normal file
@ -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
|
7
docs/api/kittycad.types.Response.rst
Normal file
7
docs/api/kittycad.types.Response.rst
Normal file
@ -0,0 +1,7 @@
|
||||
Response
|
||||
========
|
||||
|
||||
.. currentmodule:: kittycad.types
|
||||
|
||||
.. autoclass:: Response
|
||||
:show-inheritance:
|
@ -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: fedaf56120cb91b327d8a023250f850a
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
BIN
docs/html/.doctrees/api/kittycad.AuthenticatedClient.doctree
Normal file
BIN
docs/html/.doctrees/api/kittycad.AuthenticatedClient.doctree
Normal file
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
docs/html/.doctrees/api/kittycad.api.meta.ping.asyncio.doctree
Normal file
BIN
docs/html/.doctrees/api/kittycad.api.meta.ping.asyncio.doctree
Normal file
Binary file not shown.
Binary file not shown.
BIN
docs/html/.doctrees/api/kittycad.api.meta.ping.sync.doctree
Normal file
BIN
docs/html/.doctrees/api/kittycad.api.meta.ping.sync.doctree
Normal file
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
docs/html/.doctrees/api/kittycad.client.Client.doctree
Normal file
BIN
docs/html/.doctrees/api/kittycad.client.Client.doctree
Normal file
Binary file not shown.
BIN
docs/html/.doctrees/api/kittycad.models.AuthSession.doctree
Normal file
BIN
docs/html/.doctrees/api/kittycad.models.AuthSession.doctree
Normal file
Binary file not shown.
BIN
docs/html/.doctrees/api/kittycad.models.Environment.doctree
Normal file
BIN
docs/html/.doctrees/api/kittycad.models.Environment.doctree
Normal file
Binary file not shown.
BIN
docs/html/.doctrees/api/kittycad.models.ErrorMessage.doctree
Normal file
BIN
docs/html/.doctrees/api/kittycad.models.ErrorMessage.doctree
Normal file
Binary file not shown.
BIN
docs/html/.doctrees/api/kittycad.models.FileConversion.doctree
Normal file
BIN
docs/html/.doctrees/api/kittycad.models.FileConversion.doctree
Normal file
Binary file not shown.
Binary file not shown.
BIN
docs/html/.doctrees/api/kittycad.models.InstanceMetadata.doctree
Normal file
BIN
docs/html/.doctrees/api/kittycad.models.InstanceMetadata.doctree
Normal file
Binary file not shown.
BIN
docs/html/.doctrees/api/kittycad.models.Message.doctree
Normal file
BIN
docs/html/.doctrees/api/kittycad.models.Message.doctree
Normal file
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user