diff --git a/.github/workflows/generate-docs.yml b/.github/workflows/generate-docs.yml index c46f90670..340d3b3a7 100644 --- a/.github/workflows/generate-docs.yml +++ b/.github/workflows/generate-docs.yml @@ -44,7 +44,6 @@ jobs: rm -rf docs/html poetry install poetry run sphinx-build -b html docs/ docs/html/ - for f in `poetry run python -m pydoc -k kittycad | awk '{ print $1}'`; do poetry run python -m pydoc -w $f; done - name: Check for modified files id: git-check diff --git a/kittycad.api.file.file_conversion_by_id.html b/kittycad.api.file.file_conversion_by_id.html deleted file mode 100644 index 67f8ddaa2..000000000 --- a/kittycad.api.file.file_conversion_by_id.html +++ /dev/null @@ -1,43 +0,0 @@ - -Python: module kittycad.api.file.file_conversion_by_id - - - - - -
 
- 
kittycad.api.file.file_conversion_by_id		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_conversion_by_id.py
-

-

- - - - - -
 
-Modules
       
httpx
-

- - - - - -
 
-Functions
       
async asyncio(id: str, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]
Get the status of a file conversion.
-
async asyncio_detailed(id: str, *, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]
-
sync(id: str, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]
Get the status of a file conversion.
-
sync_detailed(id: str, *, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]
-

- - - - - -
 
-Data
       Any = typing.Any
-Dict = typing.Dict
-Optional = typing.Optional
-Union = typing.Union
- \ No newline at end of file diff --git a/kittycad.api.file.file_convert.html b/kittycad.api.file.file_convert.html deleted file mode 100644 index 67d74efca..000000000 --- a/kittycad.api.file.file_convert.html +++ /dev/null @@ -1,43 +0,0 @@ - -Python: module kittycad.api.file.file_convert - - - - - -
 
- 
kittycad.api.file.file_convert		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_convert.py
-

-

- - - - - -
 
-Modules
       
httpx
-

- - - - - -
 
-Functions
       
async asyncio(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]
Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously.
-
async asyncio_detailed(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]
-
sync(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]
Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously.
-
sync_detailed(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]
-

- - - - - -
 
-Data
       Any = typing.Any
-Dict = typing.Dict
-Optional = typing.Optional
-Union = typing.Union
- \ No newline at end of file diff --git a/kittycad.api.file.file_convert_with_base64_helper.html b/kittycad.api.file.file_convert_with_base64_helper.html deleted file mode 100644 index f37c8969b..000000000 --- a/kittycad.api.file.file_convert_with_base64_helper.html +++ /dev/null @@ -1,41 +0,0 @@ - -Python: module kittycad.api.file.file_convert_with_base64_helper - - - - - -
 
- 
kittycad.api.file.file_convert_with_base64_helper		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_convert_with_base64_helper.py
-

-

- - - - - -
 
-Modules
       
httpx
-

- - - - - -
 
-Functions
       
async asyncio(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]
Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously. This function automatically base64 encodes the request body and base64 decodes the request output.
-
sync(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]
Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously. This function automatically base64 encodes the request body and base64 decodes the request output.
-

- - - - - -
 
-Data
       Any = typing.Any
-Dict = typing.Dict
-Optional = typing.Optional
-Union = typing.Union
- \ No newline at end of file diff --git a/kittycad.api.file.html b/kittycad.api.file.html deleted file mode 100644 index 06a6bdc0b..000000000 --- a/kittycad.api.file.html +++ /dev/null @@ -1,24 +0,0 @@ - -Python: package kittycad.api.file - - - - - -
 
- 
kittycad.api.file		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/__init__.py
-

-

- - - - - -
 
-Package Contents
       
file_conversion_by_id
-		file_convert
-		file_convert_with_base64_helper
-
- \ No newline at end of file diff --git a/kittycad.api.html b/kittycad.api.html deleted file mode 100644 index 05ad564b2..000000000 --- a/kittycad.api.html +++ /dev/null @@ -1,23 +0,0 @@ - -Python: package kittycad.api - - - - - -
 
- 
kittycad.api		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/__init__.py
-

Contains methods for accessing the API

-

- - - - - -
 
-Package Contents
       
file (package)
-		meta (package)
-
- \ No newline at end of file diff --git a/kittycad.api.meta.html b/kittycad.api.meta.html deleted file mode 100644 index e15bee581..000000000 --- a/kittycad.api.meta.html +++ /dev/null @@ -1,24 +0,0 @@ - -Python: package kittycad.api.meta - - - - - -
 
- 
kittycad.api.meta		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/__init__.py
-

-

- - - - - -
 
-Package Contents
       
meta_debug_instance
-		meta_debug_session
-		ping
-
- \ No newline at end of file diff --git a/kittycad.api.meta.meta_debug_instance.html b/kittycad.api.meta.meta_debug_instance.html deleted file mode 100644 index ce7f9dee5..000000000 --- a/kittycad.api.meta.meta_debug_instance.html +++ /dev/null @@ -1,43 +0,0 @@ - -Python: module kittycad.api.meta.meta_debug_instance - - - - - -
 
- 
kittycad.api.meta.meta_debug_instance		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/meta_debug_instance.py
-

-

- - - - - -
 
-Modules
       
httpx
-

- - - - - -
 
-Functions
       
async asyncio(*, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.instance_metadata.InstanceMetadata, NoneType]
Get information about this specific API server instance. This is primarily used for debugging.
-
async asyncio_detailed(*, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.instance_metadata.InstanceMetadata]]
-
sync(*, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.instance_metadata.InstanceMetadata, NoneType]
Get information about this specific API server instance. This is primarily used for debugging.
-
sync_detailed(*, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.instance_metadata.InstanceMetadata]]
-

- - - - - -
 
-Data
       Any = typing.Any
-Dict = typing.Dict
-Optional = typing.Optional
-Union = typing.Union
- \ No newline at end of file diff --git a/kittycad.api.meta.meta_debug_session.html b/kittycad.api.meta.meta_debug_session.html deleted file mode 100644 index 237a0a514..000000000 --- a/kittycad.api.meta.meta_debug_session.html +++ /dev/null @@ -1,43 +0,0 @@ - -Python: module kittycad.api.meta.meta_debug_session - - - - - -
 
- 
kittycad.api.meta.meta_debug_session		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/meta_debug_session.py
-

-

- - - - - -
 
-Modules
       
httpx
-

- - - - - -
 
-Functions
       
async asyncio(*, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.auth_session.AuthSession, NoneType]
Get information about your API request session. This is primarily used for debugging.
-
async asyncio_detailed(*, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.auth_session.AuthSession]]
-
sync(*, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.auth_session.AuthSession, NoneType]
Get information about your API request session. This is primarily used for debugging.
-
sync_detailed(*, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.auth_session.AuthSession]]
-

- - - - - -
 
-Data
       Any = typing.Any
-Dict = typing.Dict
-Optional = typing.Optional
-Union = typing.Union
- \ No newline at end of file diff --git a/kittycad.api.meta.ping.html b/kittycad.api.meta.ping.html deleted file mode 100644 index 31eff1cc0..000000000 --- a/kittycad.api.meta.ping.html +++ /dev/null @@ -1,42 +0,0 @@ - -Python: module kittycad.api.meta.ping - - - - - -
 
- 
kittycad.api.meta.ping		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/ping.py
-

-

- - - - - -
 
-Modules
       
httpx
-

- - - - - -
 
-Functions
       
async asyncio(*, client: kittycad.client.Client) -> Optional[kittycad.models.message.Message]
Simple ping to the server.
-
async asyncio_detailed(*, client: kittycad.client.Client) -> kittycad.types.Response[kittycad.models.message.Message]
-
sync(*, client: kittycad.client.Client) -> Optional[kittycad.models.message.Message]
Simple ping to the server.
-
sync_detailed(*, client: kittycad.client.Client) -> kittycad.types.Response[kittycad.models.message.Message]
-

- - - - - -
 
-Data
       Any = typing.Any
-Dict = typing.Dict
-Optional = typing.Optional
- \ No newline at end of file diff --git a/kittycad.client.html b/kittycad.client.html deleted file mode 100644 index 69f4c4eaa..000000000 --- a/kittycad.client.html +++ /dev/null @@ -1,171 +0,0 @@ - -Python: module kittycad.client - - - - - -
 
- 
kittycad.client		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/client.py
-

-

- - - - - -
 
-Modules
       
attr
-		ssl
-

- - - - - -
 
-Classes
       
-
builtins.object -
-
-
Client -
-
-
AuthenticatedClient -
-
-
-
-
-

- - - - - - - -
 
-class AuthenticatedClient(Client)
   AuthenticatedClient(base_url: str = 'https://api.kittycad.io', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True, token: str) -> None
- 
-A Client which has been authenticated for use on secured endpoints
 
 
Method resolution order:
-
AuthenticatedClient
-
Client
-
builtins.object
-
-
-Methods defined here:
-
__eq__(self, other)
Method generated by attrs for class AuthenticatedClient.
- -
__ge__(self, other)
Method generated by attrs for class AuthenticatedClient.
- -
__gt__(self, other)
Method generated by attrs for class AuthenticatedClient.
- -
__init__(self, base_url: str = 'https://api.kittycad.io', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True, token: str) -> None
Method generated by attrs for class AuthenticatedClient.
- -
__le__(self, other)
Method generated by attrs for class AuthenticatedClient.
- -
__lt__(self, other)
Method generated by attrs for class AuthenticatedClient.
- -
__ne__(self, other)
Method generated by attrs for class AuthenticatedClient.
- -
__repr__(self)
Method generated by attrs for class AuthenticatedClient.
- -
get_headers(self) -> Dict[str, str]
Get headers to be used in authenticated endpoints
- -
-Data and other attributes defined here:
-
__annotations__ = {'token': <class 'str'>}
- -
__attrs_attrs__ = (Attribute(name='base_url', default='https://api... kw_only=True, inherited=False, on_setattr=None))
- -
__hash__ = None
- -
-Methods inherited from Client:
-
get_cookies(self) -> Dict[str, str]
- -
get_timeout(self) -> float
- -
with_cookies(self, cookies: Dict[str, str]) -> 'Client'
Get a new client matching this one with additional cookies
- -
with_headers(self, headers: Dict[str, str]) -> 'Client'
Get a new client matching this one with additional headers
- -
with_timeout(self, timeout: float) -> 'Client'
Get a new client matching this one with a new timeout (in seconds)
- -
-Data descriptors inherited from Client:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class Client(builtins.object)
   Client(base_url: str = 'https://api.kittycad.io', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True) -&gt; None
- 
-A class for keeping track of data related to the API
 
 Methods defined here:
-
__eq__(self, other)
Method generated by attrs for class Client.
- -
__ge__(self, other)
Method generated by attrs for class Client.
- -
__gt__(self, other)
Method generated by attrs for class Client.
- -
__init__(self, base_url: str = 'https://api.kittycad.io', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True) -> None
Method generated by attrs for class Client.
- -
__le__(self, other)
Method generated by attrs for class Client.
- -
__lt__(self, other)
Method generated by attrs for class Client.
- -
__ne__(self, other)
Method generated by attrs for class Client.
- -
__repr__(self)
Method generated by attrs for class Client.
- -
get_cookies(self) -> Dict[str, str]
- -
get_headers(self) -> Dict[str, str]
Get headers to be used in all endpoints
- -
get_timeout(self) -> float
- -
with_cookies(self, cookies: Dict[str, str]) -> 'Client'
Get a new client matching this one with additional cookies
- -
with_headers(self, headers: Dict[str, str]) -> 'Client'
Get a new client matching this one with additional headers
- -
with_timeout(self, timeout: float) -> 'Client'
Get a new client matching this one with a new timeout (in seconds)
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes defined here:
-
__annotations__ = {'base_url': <class 'str'>, 'cookies': typing.Dict[str, str], 'headers': typing.Dict[str, str], 'timeout': <class 'float'>, 'verify_ssl': typing.Union[str, bool, ssl.SSLContext]}
- -
__attrs_attrs__ = (Attribute(name='base_url', default='https://api... kw_only=True, inherited=False, on_setattr=None))
- -
__hash__ = None
- -

- - - - - -
 
-Data
       Dict = typing.Dict
-Union = typing.Union
- \ No newline at end of file diff --git a/kittycad.html b/kittycad.html deleted file mode 100644 index 98ef3ed85..000000000 --- a/kittycad.html +++ /dev/null @@ -1,25 +0,0 @@ - -Python: package kittycad - - - - - -
 
- 
kittycad		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/__init__.py
-

A client library for accessing KittyCAD

-

- - - - - -
 
-Package Contents
       
api (package)
-		client
-		models (package)
-		types
-
- \ No newline at end of file diff --git a/kittycad.models.auth_session.html b/kittycad.models.auth_session.html deleted file mode 100644 index 4ce414c90..000000000 --- a/kittycad.models.auth_session.html +++ /dev/null @@ -1,113 +0,0 @@ - -Python: module kittycad.models.auth_session - - - - - -
 
- 
kittycad.models.auth_session		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/auth_session.py
-

-

- - - - - -
 
-Modules
       
attr
-		datetime
-

- - - - - -
 
-Classes
       
-
builtins.object -
-
-
AuthSession -
-
-
-

- - - - - - - -
 
-class AuthSession(builtins.object)
   AuthSession(created_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset object at 0x7f7de094df00&gt;, email: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f7de094df00&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f7de094df00&gt;, ip_address: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f7de094df00&gt;, is_valid: Union[kittycad.types.Unset, bool] = False, token: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f7de094df00&gt;, user_id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f7de094df00&gt;) -&gt; None
- 
-
 
 Methods defined here:
-
__contains__(self, key: str) -> bool
- -
__delitem__(self, key: str) -> None
- -
__eq__(self, other)
Method generated by attrs for class AuthSession.
- -
__ge__(self, other)
Method generated by attrs for class AuthSession.
- -
__getitem__(self, key: str) -> Any
- -
__gt__(self, other)
Method generated by attrs for class AuthSession.
- -
__init__(self, created_at: Union[kittycad.types.Unset, datetime.datetime] = <kittycad.types.Unset object at 0x7f7de094df00>, email: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>, ip_address: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>, is_valid: Union[kittycad.types.Unset, bool] = False, token: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>, user_id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>) -> None
Method generated by attrs for class AuthSession.
- -
__le__(self, other)
Method generated by attrs for class AuthSession.
- -
__lt__(self, other)
Method generated by attrs for class AuthSession.
- -
__ne__(self, other)
Method generated by attrs for class AuthSession.
- -
__repr__(self)
Method generated by attrs for class AuthSession.
- -
__setitem__(self, key: str, value: Any) -> None
- -
to_dict(self) -> Dict[str, Any]
- -
-Class methods defined here:
-
from_dict(src_dict: Dict[str, Any]) -> ~T from builtins.type
- -
-Readonly properties defined here:
-
additional_keys
-
-
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes defined here:
-
__annotations__ = {'additional_properties': typing.Dict[str, typing.Any], 'created_at': typing.Union[kittycad.types.Unset, datetime.datetime], 'email': typing.Union[kittycad.types.Unset, str], 'id': typing.Union[kittycad.types.Unset, str], 'ip_address': typing.Union[kittycad.types.Unset, str], 'is_valid': typing.Union[kittycad.types.Unset, bool], 'token': typing.Union[kittycad.types.Unset, str], 'user_id': typing.Union[kittycad.types.Unset, str]}
- -
__attrs_attrs__ = (Attribute(name='created_at', default=<kittycad....kw_only=False, inherited=False, on_setattr=None))
- -
__hash__ = None
- -

- - - - - -
 
-Data
       Any = typing.Any
-Dict = typing.Dict
-List = typing.List
-T = ~T
-Type = typing.Type
-UNSET = <kittycad.types.Unset object>
-Union = typing.Union
- \ No newline at end of file diff --git a/kittycad.models.environment.html b/kittycad.models.environment.html deleted file mode 100644 index be9615223..000000000 --- a/kittycad.models.environment.html +++ /dev/null @@ -1,76 +0,0 @@ - -Python: module kittycad.models.environment - - - - - -
 
- 
kittycad.models.environment		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/environment.py
-

-

- - - - - -
 
-Classes
       
-
builtins.str(builtins.object) -
-
-
Environment(builtins.str, enum.Enum) -
-
-
enum.Enum(builtins.object) -
-
-
Environment(builtins.str, enum.Enum) -
-
-
-

- - - - - - - -
 
-class Environment(builtins.str, enum.Enum)
   Environment(value, names=None, *, module=None, qualname=None, type=None, start=1)
- 
-An enumeration.
 
 
Method resolution order:
-
Environment
-
builtins.str
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
DEVELOPMENT = <Environment.DEVELOPMENT: 'DEVELOPMENT'>
- -
PREVIEW = <Environment.PREVIEW: 'PREVIEW'>
- -
PRODUCTION = <Environment.PRODUCTION: 'PRODUCTION'>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Readonly properties inherited from enum.EnumMeta:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases. Note that this
-is a read-only view of the internal mapping.
-
-

- \ No newline at end of file diff --git a/kittycad.models.error_message.html b/kittycad.models.error_message.html deleted file mode 100644 index a8e4d1ff0..000000000 --- a/kittycad.models.error_message.html +++ /dev/null @@ -1,112 +0,0 @@ - -Python: module kittycad.models.error_message - - - - - -
 
- 
kittycad.models.error_message		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/error_message.py
-

-

- - - - - -
 
-Modules
       
attr
-

- - - - - -
 
-Classes
       
-
builtins.object -
-
-
ErrorMessage -
-
-
-

- - - - - - - -
 
-class ErrorMessage(builtins.object)
   ErrorMessage(message: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7ffadb4edf60&gt;) -&gt; None
- 
-
 
 Methods defined here:
-
__contains__(self, key: str) -> bool
- -
__delitem__(self, key: str) -> None
- -
__eq__(self, other)
Method generated by attrs for class ErrorMessage.
- -
__ge__(self, other)
Method generated by attrs for class ErrorMessage.
- -
__getitem__(self, key: str) -> Any
- -
__gt__(self, other)
Method generated by attrs for class ErrorMessage.
- -
__init__(self, message: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7ffadb4edf60>) -> None
Method generated by attrs for class ErrorMessage.
- -
__le__(self, other)
Method generated by attrs for class ErrorMessage.
- -
__lt__(self, other)
Method generated by attrs for class ErrorMessage.
- -
__ne__(self, other)
Method generated by attrs for class ErrorMessage.
- -
__repr__(self)
Method generated by attrs for class ErrorMessage.
- -
__setitem__(self, key: str, value: Any) -> None
- -
to_dict(self) -> Dict[str, Any]
- -
-Class methods defined here:
-
from_dict(src_dict: Dict[str, Any]) -> ~T from builtins.type
- -
-Readonly properties defined here:
-
additional_keys
-
-
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes defined here:
-
__annotations__ = {'additional_properties': typing.Dict[str, typing.Any], 'message': typing.Union[kittycad.types.Unset, str]}
- -
__attrs_attrs__ = (Attribute(name='message', default=<kittycad.typ...kw_only=False, inherited=False, on_setattr=None))
- -
__hash__ = None
- -

- - - - - -
 
-Data
       Any = typing.Any
-Dict = typing.Dict
-List = typing.List
-T = ~T
-Type = typing.Type
-UNSET = <kittycad.types.Unset object>
-Union = typing.Union
- \ No newline at end of file diff --git a/kittycad.models.file_conversion.html b/kittycad.models.file_conversion.html deleted file mode 100644 index dd41c8651..000000000 --- a/kittycad.models.file_conversion.html +++ /dev/null @@ -1,113 +0,0 @@ - -Python: module kittycad.models.file_conversion - - - - - -
 
- 
kittycad.models.file_conversion		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/file_conversion.py
-

-

- - - - - -
 
-Modules
       
attr
-		datetime
-

- - - - - -
 
-Classes
       
-
builtins.object -
-
-
FileConversion -
-
-
-

- - - - - - - -
 
-class FileConversion(builtins.object)
   FileConversion(completed_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;, created_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;, output: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;, output_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;, src_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;, status: Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;) -&gt; None
- 
-
 
 Methods defined here:
-
__contains__(self, key: str) -> bool
- -
__delitem__(self, key: str) -> None
- -
__eq__(self, other)
Method generated by attrs for class FileConversion.
- -
__ge__(self, other)
Method generated by attrs for class FileConversion.
- -
__getitem__(self, key: str) -> Any
- -
__gt__(self, other)
Method generated by attrs for class FileConversion.
- -
__init__(self, completed_at: Union[kittycad.types.Unset, datetime.datetime] = <kittycad.types.Unset object at 0x7f1916e0df60>, created_at: Union[kittycad.types.Unset, datetime.datetime] = <kittycad.types.Unset object at 0x7f1916e0df60>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f1916e0df60>, output: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f1916e0df60>, output_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = <kittycad.types.Unset object at 0x7f1916e0df60>, src_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = <kittycad.types.Unset object at 0x7f1916e0df60>, status: Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus] = <kittycad.types.Unset object at 0x7f1916e0df60>) -> None
Method generated by attrs for class FileConversion.
- -
__le__(self, other)
Method generated by attrs for class FileConversion.
- -
__lt__(self, other)
Method generated by attrs for class FileConversion.
- -
__ne__(self, other)
Method generated by attrs for class FileConversion.
- -
__repr__(self)
Method generated by attrs for class FileConversion.
- -
__setitem__(self, key: str, value: Any) -> None
- -
to_dict(self) -> Dict[str, Any]
- -
-Class methods defined here:
-
from_dict(src_dict: Dict[str, Any]) -> ~T from builtins.type
- -
-Readonly properties defined here:
-
additional_keys
-
-
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes defined here:
-
__annotations__ = {'additional_properties': typing.Dict[str, typing.Any], 'completed_at': typing.Union[kittycad.types.Unset, datetime.datetime], 'created_at': typing.Union[kittycad.types.Unset, datetime.datetime], 'id': typing.Union[kittycad.types.Unset, str], 'output': typing.Union[kittycad.types.Unset, str], 'output_format': typing.Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes], 'src_format': typing.Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes], 'status': typing.Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus]}
- -
__attrs_attrs__ = (Attribute(name='completed_at', default=<kittyca...kw_only=False, inherited=False, on_setattr=None))
- -
__hash__ = None
- -

- - - - - -
 
-Data
       Any = typing.Any
-Dict = typing.Dict
-List = typing.List
-T = ~T
-Type = typing.Type
-UNSET = <kittycad.types.Unset object>
-Union = typing.Union
- \ No newline at end of file diff --git a/kittycad.models.file_conversion_status.html b/kittycad.models.file_conversion_status.html deleted file mode 100644 index eb624a391..000000000 --- a/kittycad.models.file_conversion_status.html +++ /dev/null @@ -1,80 +0,0 @@ - -Python: module kittycad.models.file_conversion_status - - - - - -
 
- 
kittycad.models.file_conversion_status		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/file_conversion_status.py
-

-

- - - - - -
 
-Classes
       
-
builtins.str(builtins.object) -
-
-
FileConversionStatus(builtins.str, enum.Enum) -
-
-
enum.Enum(builtins.object) -
-
-
FileConversionStatus(builtins.str, enum.Enum) -
-
-
-

- - - - - - - -
 
-class FileConversionStatus(builtins.str, enum.Enum)
   FileConversionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1)
- 
-An enumeration.
 
 
Method resolution order:
-
FileConversionStatus
-
builtins.str
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
COMPLETED = <FileConversionStatus.COMPLETED: 'Completed'>
- -
FAILED = <FileConversionStatus.FAILED: 'Failed'>
- -
IN_PROGRESS = <FileConversionStatus.IN_PROGRESS: 'In Progress'>
- -
QUEUED = <FileConversionStatus.QUEUED: 'Queued'>
- -
UPLOADED = <FileConversionStatus.UPLOADED: 'Uploaded'>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Readonly properties inherited from enum.EnumMeta:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases. Note that this
-is a read-only view of the internal mapping.
-
-

- \ No newline at end of file diff --git a/kittycad.models.html b/kittycad.models.html deleted file mode 100644 index bc4a7e757..000000000 --- a/kittycad.models.html +++ /dev/null @@ -1,29 +0,0 @@ - -Python: package kittycad.models - - - - - -
 
- 
kittycad.models		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/__init__.py
-

Contains all the data models used in inputs/outputs

-

- - - - - -
 
-Package Contents
       
auth_session
-environment
-		error_message
-file_conversion
-		file_conversion_status
-instance_metadata
-		message
-valid_file_types
-
- \ No newline at end of file diff --git a/kittycad.models.instance_metadata.html b/kittycad.models.instance_metadata.html deleted file mode 100644 index e5fe73625..000000000 --- a/kittycad.models.instance_metadata.html +++ /dev/null @@ -1,112 +0,0 @@ - -Python: module kittycad.models.instance_metadata - - - - - -
 
- 
kittycad.models.instance_metadata		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/instance_metadata.py
-

-

- - - - - -
 
-Modules
       
attr
-

- - - - - -
 
-Classes
       
-
builtins.object -
-
-
InstanceMetadata -
-
-
-

- - - - - - - -
 
-class InstanceMetadata(builtins.object)
   InstanceMetadata(cpu_platform: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, description: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, environment: Union[kittycad.types.Unset, kittycad.models.environment.Environment] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, git_hash: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, hostname: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, image: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, ip_address: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, machine_type: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, name: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, zone: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;) -&gt; None
- 
-
 
 Methods defined here:
-
__contains__(self, key: str) -> bool
- -
__delitem__(self, key: str) -> None
- -
__eq__(self, other)
Method generated by attrs for class InstanceMetadata.
- -
__ge__(self, other)
Method generated by attrs for class InstanceMetadata.
- -
__getitem__(self, key: str) -> Any
- -
__gt__(self, other)
Method generated by attrs for class InstanceMetadata.
- -
__init__(self, cpu_platform: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, description: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, environment: Union[kittycad.types.Unset, kittycad.models.environment.Environment] = <kittycad.types.Unset object at 0x7f0df2f31f60>, git_hash: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, hostname: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, image: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, ip_address: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, machine_type: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, name: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, zone: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>) -> None
Method generated by attrs for class InstanceMetadata.
- -
__le__(self, other)
Method generated by attrs for class InstanceMetadata.
- -
__lt__(self, other)
Method generated by attrs for class InstanceMetadata.
- -
__ne__(self, other)
Method generated by attrs for class InstanceMetadata.
- -
__repr__(self)
Method generated by attrs for class InstanceMetadata.
- -
__setitem__(self, key: str, value: Any) -> None
- -
to_dict(self) -> Dict[str, Any]
- -
-Class methods defined here:
-
from_dict(src_dict: Dict[str, Any]) -> ~T from builtins.type
- -
-Readonly properties defined here:
-
additional_keys
-
-
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes defined here:
-
__annotations__ = {'additional_properties': typing.Dict[str, typing.Any], 'cpu_platform': typing.Union[kittycad.types.Unset, str], 'description': typing.Union[kittycad.types.Unset, str], 'environment': typing.Union[kittycad.types.Unset, kittycad.models.environment.Environment], 'git_hash': typing.Union[kittycad.types.Unset, str], 'hostname': typing.Union[kittycad.types.Unset, str], 'id': typing.Union[kittycad.types.Unset, str], 'image': typing.Union[kittycad.types.Unset, str], 'ip_address': typing.Union[kittycad.types.Unset, str], 'machine_type': typing.Union[kittycad.types.Unset, str], ...}
- -
__attrs_attrs__ = (Attribute(name='cpu_platform', default=<kittyca...kw_only=False, inherited=False, on_setattr=None))
- -
__hash__ = None
- -

- - - - - -
 
-Data
       Any = typing.Any
-Dict = typing.Dict
-List = typing.List
-T = ~T
-Type = typing.Type
-UNSET = <kittycad.types.Unset object>
-Union = typing.Union
- \ No newline at end of file diff --git a/kittycad.models.message.html b/kittycad.models.message.html deleted file mode 100644 index e6f511ee6..000000000 --- a/kittycad.models.message.html +++ /dev/null @@ -1,112 +0,0 @@ - -Python: module kittycad.models.message - - - - - -
 
- 
kittycad.models.message		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/message.py
-

-

- - - - - -
 
-Modules
       
attr
-

- - - - - -
 
-Classes
       
-
builtins.object -
-
-
Message -
-
-
-

- - - - - - - -
 
-class Message(builtins.object)
   Message(message: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f10e92f9f60&gt;) -&gt; None
- 
-
 
 Methods defined here:
-
__contains__(self, key: str) -> bool
- -
__delitem__(self, key: str) -> None
- -
__eq__(self, other)
Method generated by attrs for class Message.
- -
__ge__(self, other)
Method generated by attrs for class Message.
- -
__getitem__(self, key: str) -> Any
- -
__gt__(self, other)
Method generated by attrs for class Message.
- -
__init__(self, message: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f10e92f9f60>) -> None
Method generated by attrs for class Message.
- -
__le__(self, other)
Method generated by attrs for class Message.
- -
__lt__(self, other)
Method generated by attrs for class Message.
- -
__ne__(self, other)
Method generated by attrs for class Message.
- -
__repr__(self)
Method generated by attrs for class Message.
- -
__setitem__(self, key: str, value: Any) -> None
- -
to_dict(self) -> Dict[str, Any]
- -
-Class methods defined here:
-
from_dict(src_dict: Dict[str, Any]) -> ~T from builtins.type
- -
-Readonly properties defined here:
-
additional_keys
-
-
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes defined here:
-
__annotations__ = {'additional_properties': typing.Dict[str, typing.Any], 'message': typing.Union[kittycad.types.Unset, str]}
- -
__attrs_attrs__ = (Attribute(name='message', default=<kittycad.typ...kw_only=False, inherited=False, on_setattr=None))
- -
__hash__ = None
- -

- - - - - -
 
-Data
       Any = typing.Any
-Dict = typing.Dict
-List = typing.List
-T = ~T
-Type = typing.Type
-UNSET = <kittycad.types.Unset object>
-Union = typing.Union
- \ No newline at end of file diff --git a/kittycad.models.valid_file_types.html b/kittycad.models.valid_file_types.html deleted file mode 100644 index ba855fc93..000000000 --- a/kittycad.models.valid_file_types.html +++ /dev/null @@ -1,80 +0,0 @@ - -Python: module kittycad.models.valid_file_types - - - - - -
 
- 
kittycad.models.valid_file_types		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/valid_file_types.py
-

-

- - - - - -
 
-Classes
       
-
builtins.str(builtins.object) -
-
-
ValidFileTypes(builtins.str, enum.Enum) -
-
-
enum.Enum(builtins.object) -
-
-
ValidFileTypes(builtins.str, enum.Enum) -
-
-
-

- - - - - - - -
 
-class ValidFileTypes(builtins.str, enum.Enum)
   ValidFileTypes(value, names=None, *, module=None, qualname=None, type=None, start=1)
- 
-An enumeration.
 
 
Method resolution order:
-
ValidFileTypes
-
builtins.str
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
DWG = <ValidFileTypes.DWG: 'dwg'>
- -
DXF = <ValidFileTypes.DXF: 'dxf'>
- -
OBJ = <ValidFileTypes.OBJ: 'obj'>
- -
STEP = <ValidFileTypes.STEP: 'step'>
- -
STL = <ValidFileTypes.STL: 'stl'>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Readonly properties inherited from enum.EnumMeta:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases. Note that this
-is a read-only view of the internal mapping.
-
-

- \ No newline at end of file diff --git a/kittycad.types.html b/kittycad.types.html deleted file mode 100644 index 29a61504f..000000000 --- a/kittycad.types.html +++ /dev/null @@ -1,161 +0,0 @@ - -Python: module kittycad.types - - - - - -
 
- 
kittycad.types		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/types.py
-

Contains some shared types for properties

-

- - - - - -
 
-Modules
       
attr
-

- - - - - -
 
-Classes
       
-
builtins.object -
-
-
File -
-
-
typing.Generic(builtins.object) -
-
-
Response -
-
-
-

- - - - - - - -
 
-class File(builtins.object)
   File(payload: Union[BinaryIO, TextIO], file_name: Optional[str] = None, mime_type: Optional[str] = None) -&gt; None
- 
-Contains information for file uploads
 
 Methods defined here:
-
__eq__(self, other)
Method generated by attrs for class File.
- -
__ge__(self, other)
Method generated by attrs for class File.
- -
__gt__(self, other)
Method generated by attrs for class File.
- -
__init__(self, payload: Union[BinaryIO, TextIO], file_name: Optional[str] = None, mime_type: Optional[str] = None) -> None
Method generated by attrs for class File.
- -
__le__(self, other)
Method generated by attrs for class File.
- -
__lt__(self, other)
Method generated by attrs for class File.
- -
__ne__(self, other)
Method generated by attrs for class File.
- -
__repr__(self)
Method generated by attrs for class File.
- -
to_tuple(self) -> Tuple[Optional[str], Union[BinaryIO, TextIO], Optional[str]]
Return a tuple representation that httpx will accept for multipart/form-data
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes defined here:
-
__annotations__ = {'file_name': typing.Optional[str], 'mime_type': typing.Optional[str], 'payload': typing.Union[typing.BinaryIO, typing.TextIO]}
- -
__attrs_attrs__ = (Attribute(name='payload', default=NOTHING, vali...kw_only=False, inherited=False, on_setattr=None))
- -
__hash__ = None
- -

- - - - - - - -
 
-class Response(typing.Generic)
   Response(status_code: int, content: bytes, headers: MutableMapping[str, str], parsed: Optional[~T]) -&gt; None
- 
-A response from an endpoint
 
 
Method resolution order:
-
Response
-
typing.Generic
-
builtins.object
-
-
-Methods defined here:
-
__eq__(self, other)
Method generated by attrs for class Response.
- -
__ge__(self, other)
Method generated by attrs for class Response.
- -
__gt__(self, other)
Method generated by attrs for class Response.
- -
__init__(self, status_code: int, content: bytes, headers: MutableMapping[str, str], parsed: Optional[~T]) -> None
Method generated by attrs for class Response.
- -
__le__(self, other)
Method generated by attrs for class Response.
- -
__lt__(self, other)
Method generated by attrs for class Response.
- -
__ne__(self, other)
Method generated by attrs for class Response.
- -
__repr__(self)
Method generated by attrs for class Response.
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes defined here:
-
__annotations__ = {'content': <class 'bytes'>, 'headers': typing.MutableMapping[str, str], 'parsed': typing.Optional[~T], 'status_code': <class 'int'>}
- -
__attrs_attrs__ = (Attribute(name='status_code', default=NOTHING, ...kw_only=False, inherited=False, on_setattr=None))
- -
__hash__ = None
- -
__orig_bases__ = (typing.Generic[~T],)
- -
__parameters__ = (~T,)
- -
-Class methods inherited from typing.Generic:
-
__class_getitem__(params) from builtins.type
- -
__init_subclass__(*args, **kwargs) from builtins.type
This method is called when a class is subclassed.
- 
-The default implementation does nothing. It may be
-overridden to extend subclasses.
- -

- - - - - -
 
-Data
       FileJsonType = typing.Tuple[typing.Optional[str], typing.Union[...g.BinaryIO, typing.TextIO], typing.Optional[str]]
-__all__ = ['File', 'Response', 'FileJsonType']
-__annotations__ = {'UNSET': <class 'kittycad.types.Unset'>}
- \ No newline at end of file