Compare commits
54 Commits
Author | SHA1 | Date | |
---|---|---|---|
363e9aea12 | |||
ca263dd395 | |||
1e2e9c0871 | |||
6db080ebc8 | |||
5247831f32 | |||
5e204bf872 | |||
9cbcebf665 | |||
fdc005a2f7 | |||
004daabdf9 | |||
a14fa0b099 | |||
020b19a3c2 | |||
d2ea7ddf66 | |||
6210725498 | |||
3531fd4197 | |||
1c94c0500c | |||
eae6825815 | |||
a11d9e9351 | |||
5d985a3e13 | |||
6b6de6ddf2 | |||
aa723677a3 | |||
3477374e44 | |||
f28d56915a | |||
cf3ab0f291 | |||
e53597609c | |||
3d8c49afe3 | |||
669b7aded0 | |||
0ceebbee9c | |||
ab01c82bb7 | |||
65e95eae3d | |||
5fcd6d048e | |||
89a450f697 | |||
653d2b21ee | |||
cbf5f4df6d | |||
2d90bb61be | |||
9c18ba2350 | |||
0b9c32e6bf | |||
b09684bd9e | |||
45ac31914d | |||
2a9ae9dc8d | |||
5b77fbdbd0 | |||
e0f88cf27a | |||
29b0d3b5d0 | |||
6c05eabb2c | |||
be59e657b9 | |||
bf83d1f1ba | |||
a99251b3b7 | |||
32479cfe2a | |||
2a3cec9aac | |||
e7aaaab78d | |||
f835e905a9 | |||
637df816fd | |||
cef71917e8 | |||
c865f88379 | |||
7dbafade7a |
0
.dockerignore
Normal file
0
.dockerignore
Normal file
4
.github/dependabot.yml
vendored
4
.github/dependabot.yml
vendored
@ -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"
|
||||
|
8
.github/workflows/build-test.yml
vendored
8
.github/workflows/build-test.yml
vendored
@ -5,10 +5,14 @@ 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:
|
||||
|
||||
@ -18,9 +22,9 @@ jobs:
|
||||
python-version: [3.6, 3.7, 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@v3
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
|
10
.github/workflows/generate-docs.yml
vendored
10
.github/workflows/generate-docs.yml
vendored
@ -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@v3
|
||||
with:
|
||||
python-version: 3.x
|
||||
|
||||
|
3
.github/workflows/generate.yml
vendored
3
.github/workflows/generate.yml
vendored
@ -6,6 +6,7 @@ on:
|
||||
paths:
|
||||
- 'Makefile'
|
||||
- .github/workflows/generate.yml
|
||||
- 'spec.json'
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
jobs:
|
||||
@ -14,7 +15,7 @@ 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
|
||||
|
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@v2
|
||||
- uses: actions/setup-python@v2
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-python@v3
|
||||
with:
|
||||
python-version: '3.x'
|
||||
# Installation instructions are from: https://python-poetry.org/docs/
|
||||
|
69
.github/workflows/update-spec-for-docs.yml
vendored
Normal file
69
.github/workflows/update-spec-for-docs.yml
vendored
Normal file
@ -0,0 +1,69 @@
|
||||
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
|
||||
- uses: actions/setup-go@v2
|
||||
with:
|
||||
go-version: '1.x'
|
||||
- name: make generate
|
||||
shell: bash
|
||||
run: |
|
||||
make generate
|
||||
# Ensure no files changed.
|
||||
- name: Ensure no files changed
|
||||
shell: bash
|
||||
run: |
|
||||
if [[ `git status --porcelain` ]]; 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/docs'
|
||||
path: 'docs'
|
||||
token: ${{secrets.PAT_GITHUB}}
|
||||
- name: move spec to docs
|
||||
shell: bash
|
||||
run: |
|
||||
rm docs/spec.json || true
|
||||
cp spec.json docs/spec.json
|
||||
- name: commit the changes in the docs repo
|
||||
shell: bash
|
||||
run: |
|
||||
export VERSION=$(cat VERSION.txt);
|
||||
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 DOCS ${VERSION}!" || exit 0
|
||||
git fetch origin
|
||||
git rebase origin/main || exit 0
|
||||
export NEW_BRANCH="update-spec-${VERSION}"
|
||||
git checkout -b "$NEW_BRANCH"
|
||||
git push -f origin "$NEW_BRANCH"
|
||||
gh pr create --title "Update lang spec docs for ${VERSION}" \
|
||||
--body "Updating the generated docs for go lang" \
|
||||
--head "$NEW_BRANCH" \
|
||||
--base main || true
|
||||
env:
|
||||
GITHUB_TOKEN: ${{secrets.PAT_GITHUB}}
|
||||
|
||||
|
10
Dockerfile
10
Dockerfile
@ -1,7 +1,13 @@
|
||||
FROM python:latest
|
||||
FROM python:3.9
|
||||
|
||||
RUN pip install \
|
||||
openapi-python-client
|
||||
poetry
|
||||
|
||||
WORKDIR /usr/src/
|
||||
|
||||
COPY . /usr/src/
|
||||
|
||||
RUN poetry update && poetry install
|
||||
|
||||
# Set the default command to bash.
|
||||
CMD ["bash"]
|
||||
|
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -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.
|
19
Makefile
19
Makefile
@ -10,14 +10,21 @@ 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
|
||||
-v $(CURDIR):/usr/src \
|
||||
--workdir /usr/src \
|
||||
$(DOCKER_IMAGE_NAME) sh -c 'poetry run python generate/generate.py && poetry run autopep8 --in-place --aggressive --aggressive kittycad/models/*.py && poetry run autopep8 --in-place --aggressive --aggressive kittycad/api/*.py && poetry run autopep8 --in-place --aggressive --aggressive kittycad/*.py && poetry run autopep8 --in-place --aggressive --aggressive generate/*.py'
|
||||
|
||||
.PHONY: shell
|
||||
shell: docker-image ## Pop into a shell in the docker image.
|
||||
docker run --rm -i $(DOCKER_FLAGS) \
|
||||
--name python-generator-shell \
|
||||
-v $(CURDIR):/usr/src \
|
||||
--workdir /usr/src \
|
||||
$(DOCKER_IMAGE_NAME) /bin/bash
|
||||
|
||||
|
||||
.PHONY: docker-image
|
||||
docker-image:
|
||||
|
44
README.md
44
README.md
@ -2,9 +2,6 @@
|
||||
|
||||
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 +23,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)
|
||||
```
|
||||
|
@ -1,2 +0,0 @@
|
||||
project_name_override: kittycad
|
||||
package_name_override: kittycad
|
@ -1,16 +1,16 @@
|
||||
AuthenticatedClient
|
||||
===================
|
||||
ClientFromEnv
|
||||
=============
|
||||
|
||||
.. currentmodule:: kittycad
|
||||
|
||||
.. autoclass:: AuthenticatedClient
|
||||
.. autoclass:: ClientFromEnv
|
||||
:show-inheritance:
|
||||
|
||||
.. rubric:: Methods Summary
|
||||
|
||||
.. autosummary::
|
||||
|
||||
~AuthenticatedClient.get_headers
|
||||
~ClientFromEnv.get_headers
|
||||
|
||||
.. rubric:: Methods Documentation
|
||||
|
@ -1,6 +0,0 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_conversion_by_id
|
||||
|
||||
.. autofunction:: asyncio
|
@ -1,6 +0,0 @@
|
||||
asyncio_detailed
|
||||
================
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_conversion_by_id
|
||||
|
||||
.. autofunction:: asyncio_detailed
|
@ -1,6 +0,0 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_conversion_by_id
|
||||
|
||||
.. autofunction:: sync
|
@ -1,6 +0,0 @@
|
||||
sync_detailed
|
||||
=============
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_conversion_by_id
|
||||
|
||||
.. autofunction:: sync_detailed
|
@ -1,6 +0,0 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_conversion_by_id_with_base64_helper
|
||||
|
||||
.. autofunction:: asyncio
|
@ -1,6 +0,0 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_conversion_by_id_with_base64_helper
|
||||
|
||||
.. autofunction:: sync
|
@ -1,6 +0,0 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_convert
|
||||
|
||||
.. autofunction:: asyncio
|
@ -1,6 +0,0 @@
|
||||
asyncio_detailed
|
||||
================
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_convert
|
||||
|
||||
.. autofunction:: asyncio_detailed
|
@ -1,6 +0,0 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_convert
|
||||
|
||||
.. autofunction:: sync
|
@ -1,6 +0,0 @@
|
||||
sync_detailed
|
||||
=============
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_convert
|
||||
|
||||
.. autofunction:: sync_detailed
|
@ -1,6 +0,0 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_convert_with_base64_helper
|
||||
|
||||
.. autofunction:: asyncio
|
@ -1,6 +0,0 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.file.file_convert_with_base64_helper
|
||||
|
||||
.. autofunction:: sync
|
@ -1,6 +0,0 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_instance
|
||||
|
||||
.. autofunction:: asyncio
|
@ -1,6 +0,0 @@
|
||||
asyncio_detailed
|
||||
================
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_instance
|
||||
|
||||
.. autofunction:: asyncio_detailed
|
@ -1,6 +0,0 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_instance
|
||||
|
||||
.. autofunction:: sync
|
@ -1,6 +0,0 @@
|
||||
sync_detailed
|
||||
=============
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_instance
|
||||
|
||||
.. autofunction:: sync_detailed
|
@ -1,6 +0,0 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_session
|
||||
|
||||
.. autofunction:: asyncio
|
@ -1,6 +0,0 @@
|
||||
asyncio_detailed
|
||||
================
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_session
|
||||
|
||||
.. autofunction:: asyncio_detailed
|
@ -1,6 +0,0 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_session
|
||||
|
||||
.. autofunction:: sync
|
@ -1,6 +0,0 @@
|
||||
sync_detailed
|
||||
=============
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.meta_debug_session
|
||||
|
||||
.. autofunction:: sync_detailed
|
@ -1,6 +0,0 @@
|
||||
asyncio
|
||||
=======
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.ping
|
||||
|
||||
.. autofunction:: asyncio
|
@ -1,6 +0,0 @@
|
||||
asyncio_detailed
|
||||
================
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.ping
|
||||
|
||||
.. autofunction:: asyncio_detailed
|
@ -1,6 +0,0 @@
|
||||
sync
|
||||
====
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.ping
|
||||
|
||||
.. autofunction:: sync
|
@ -1,6 +0,0 @@
|
||||
sync_detailed
|
||||
=============
|
||||
|
||||
.. currentmodule:: kittycad.api.meta.ping
|
||||
|
||||
.. autofunction:: sync_detailed
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -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
|
@ -1,7 +0,0 @@
|
||||
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: e70151257d05c54cbec2f82169462e1b
|
||||
config: 74989a7dc76cd38543fd6db0578bbfeb
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
Binary file not shown.
Binary file not shown.
BIN
docs/html/.doctrees/api/kittycad.ClientFromEnv.doctree
Normal file
BIN
docs/html/.doctrees/api/kittycad.ClientFromEnv.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.
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.
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user