fix

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

kittycad/README.md

@@ -2,86 +2,42 @@
 A client library for accessing KittyCAD
 
 ## Usage
-First, create a client:
-
-```python
-from kittycad import Client
-
-client = Client(base_url="https://api.example.com")
-```
-
-If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+First, create an authenticated client:
 
 ```python
 from kittycad import AuthenticatedClient
 
-client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
+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 MyDataModel
-from kittycad.api.my_tag import get_my_data_model
+from kittycad.models import AuthSession
+from kittycad.api.meta import meta_debug_session
 from kittycad.types import Response
 
-my_data: MyDataModel = get_my_data_model.sync(client=client)
+session: AuthSession = meta_debug_session.sync(client=client)
 # or if you need more info (e.g. status_code)
-response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
+response: Response[AuthSession] = meta_debug_session.sync_detailed(client=client)
 ```
 
 Or do the same thing with an async version:
 
 ```python
-from kittycad.models import MyDataModel
-from kittycad.api.my_tag import get_my_data_model
+from kittycad.models import AuthSession
+from kittycad.api.meta import meta_debug_session
 from kittycad.types import Response
 
-my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
-response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
+session: AuthSession = await meta_debug_session.asyncio(client=client)
+response: Response[AuthSession] = await meta_debug_session.asyncio_detailed(client=client)
 ```
-
-By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
-
-```python
-client = AuthenticatedClient(
-    base_url="https://internal_api.example.com", 
-    token="SuperSecretToken",
-    verify_ssl="/path/to/certificate_bundle.pem",
-)
-```
-
-You can also disable certificate validation altogether, but beware that **this is a security risk**.
-
-```python
-client = AuthenticatedClient(
-    base_url="https://internal_api.example.com", 
-    token="SuperSecretToken", 
-    verify_ssl=False
-)
-```
-
-Things to know:
-1. Every path/method combo becomes a Python module with four functions:
-    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
-    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
-    1. `asyncio`: Like `sync` but the async instead of blocking
-    1. `asyncio_detailed`: Like `sync_detailed` by async instead of blocking
-
-1. All path/query params, and bodies become method arguments.
-1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
-1. Any endpoint which did not have a tag will be in `kittycad.api.default`
-
-## Building / publishing this Client
-This project uses [Poetry](https://python-poetry.org/) to manage dependencies  and packaging.  Here are the basics:
-1. Update the metadata in pyproject.toml (e.g. authors, version)
-1. If you're using a private repository, configure it with Poetry
-    1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
-    1. `poetry config http-basic.<your-repository-name> <username> <password>`
-1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`
-
-If you want to install this client into another project without publishing it (e.g. for development) then:
-1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
-1. If that project is not using Poetry:
-    1. Build a wheel with `poetry build -f wheel`
-    1. Install that wheel from the other project `pip install <path-to-wheel>`

kittycad/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kittycad"
-version = "0.0.1"
+version = "0.0.2"
 description = "A client library for accessing KittyCAD"
 
 authors = []