diff --git a/kittycad/.gitignore b/.gitignore similarity index 100% rename from kittycad/.gitignore rename to .gitignore diff --git a/Makefile b/Makefile index fc7a59e3f..1dc48f391 100644 --- a/Makefile +++ b/Makefile @@ -7,17 +7,17 @@ endif # For this to work, you need to install toml-cli: https://github.com/gnprice/toml-cli # `cargo install toml-cli` -VERSION := $(shell toml get $(CURDIR)/kittycad/pyproject.toml tool.poetry.version | jq -r .) +VERSION := $(shell toml get $(CURDIR)/pyproject.toml tool.poetry.version | jq -r .) .PHONY: generate generate: docker-image docker run --rm -i $(DOCKER_FLAGS) \ --name python-generator \ - -v $(CURDIR):/usr/src \ - --workdir /usr/src \ + -v $(CURDIR):/usr/kittycad \ + --workdir /usr \ $(DOCKER_IMAGE_NAME) openapi-python-client update \ --url https://api.kittycad.io \ - --config /usr/src/config.yml + --config /usr/kittycad/config.yml .PHONY: docker-image docker-image: diff --git a/README.md b/README.md index 1f0abcb9f..f07ce2d07 100644 --- a/README.md +++ b/README.md @@ -25,3 +25,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) +``` diff --git a/kittycad/README.md b/kittycad/README.md deleted file mode 100644 index 288a2a563..000000000 --- a/kittycad/README.md +++ /dev/null @@ -1,43 +0,0 @@ -# kittycad -A client library for accessing KittyCAD - -## 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) -``` diff --git a/kittycad/kittycad/__init__.py b/kittycad/__init__.py similarity index 100% rename from kittycad/kittycad/__init__.py rename to kittycad/__init__.py diff --git a/kittycad/kittycad/api/__init__.py b/kittycad/api/__init__.py similarity index 100% rename from kittycad/kittycad/api/__init__.py rename to kittycad/api/__init__.py diff --git a/kittycad/kittycad/api/file/__init__.py b/kittycad/api/file/__init__.py similarity index 100% rename from kittycad/kittycad/api/file/__init__.py rename to kittycad/api/file/__init__.py diff --git a/kittycad/kittycad/api/file/file_conversion_by_id.py b/kittycad/api/file/file_conversion_by_id.py similarity index 100% rename from kittycad/kittycad/api/file/file_conversion_by_id.py rename to kittycad/api/file/file_conversion_by_id.py diff --git a/kittycad/kittycad/api/file/file_convert.py b/kittycad/api/file/file_convert.py similarity index 100% rename from kittycad/kittycad/api/file/file_convert.py rename to kittycad/api/file/file_convert.py diff --git a/kittycad/kittycad/api/meta/__init__.py b/kittycad/api/meta/__init__.py similarity index 100% rename from kittycad/kittycad/api/meta/__init__.py rename to kittycad/api/meta/__init__.py diff --git a/kittycad/kittycad/api/meta/meta_debug_instance.py b/kittycad/api/meta/meta_debug_instance.py similarity index 100% rename from kittycad/kittycad/api/meta/meta_debug_instance.py rename to kittycad/api/meta/meta_debug_instance.py diff --git a/kittycad/kittycad/api/meta/meta_debug_session.py b/kittycad/api/meta/meta_debug_session.py similarity index 100% rename from kittycad/kittycad/api/meta/meta_debug_session.py rename to kittycad/api/meta/meta_debug_session.py diff --git a/kittycad/kittycad/api/meta/ping.py b/kittycad/api/meta/ping.py similarity index 100% rename from kittycad/kittycad/api/meta/ping.py rename to kittycad/api/meta/ping.py diff --git a/kittycad/kittycad/client.py b/kittycad/client.py similarity index 100% rename from kittycad/kittycad/client.py rename to kittycad/client.py diff --git a/kittycad/kittycad/models/__init__.py b/kittycad/models/__init__.py similarity index 100% rename from kittycad/kittycad/models/__init__.py rename to kittycad/models/__init__.py diff --git a/kittycad/kittycad/models/auth_session.py b/kittycad/models/auth_session.py similarity index 100% rename from kittycad/kittycad/models/auth_session.py rename to kittycad/models/auth_session.py diff --git a/kittycad/kittycad/models/environment.py b/kittycad/models/environment.py similarity index 100% rename from kittycad/kittycad/models/environment.py rename to kittycad/models/environment.py diff --git a/kittycad/kittycad/models/error_message.py b/kittycad/models/error_message.py similarity index 100% rename from kittycad/kittycad/models/error_message.py rename to kittycad/models/error_message.py diff --git a/kittycad/kittycad/models/file_conversion.py b/kittycad/models/file_conversion.py similarity index 100% rename from kittycad/kittycad/models/file_conversion.py rename to kittycad/models/file_conversion.py diff --git a/kittycad/kittycad/models/file_conversion_status.py b/kittycad/models/file_conversion_status.py similarity index 100% rename from kittycad/kittycad/models/file_conversion_status.py rename to kittycad/models/file_conversion_status.py diff --git a/kittycad/kittycad/models/instance_metadata.py b/kittycad/models/instance_metadata.py similarity index 100% rename from kittycad/kittycad/models/instance_metadata.py rename to kittycad/models/instance_metadata.py diff --git a/kittycad/kittycad/models/message.py b/kittycad/models/message.py similarity index 100% rename from kittycad/kittycad/models/message.py rename to kittycad/models/message.py diff --git a/kittycad/kittycad/models/valid_file_types.py b/kittycad/models/valid_file_types.py similarity index 100% rename from kittycad/kittycad/models/valid_file_types.py rename to kittycad/models/valid_file_types.py diff --git a/kittycad/kittycad/py.typed b/kittycad/py.typed similarity index 100% rename from kittycad/kittycad/py.typed rename to kittycad/py.typed diff --git a/kittycad/kittycad/types.py b/kittycad/types.py similarity index 100% rename from kittycad/kittycad/types.py rename to kittycad/types.py diff --git a/kittycad/pyproject.toml b/pyproject.toml similarity index 100% rename from kittycad/pyproject.toml rename to pyproject.toml