2021-12-06 12:24:34 -08:00
|
|
|
# kittycad.py
|
|
|
|
|
|
2021-12-06 12:43:34 -08:00
|
|
|
The Python API client for KittyCAD.
|
2021-12-06 12:24:34 -08:00
|
|
|
|
|
|
|
|
This is generated from
|
|
|
|
|
[openapi-generators/openapi-python-client](https://github.com/openapi-generators/openapi-python-client).
|
|
|
|
|
|
2021-12-06 12:43:34 -08:00
|
|
|
## Generating
|
|
|
|
|
|
2021-12-06 12:24:34 -08:00
|
|
|
You can trigger a build with the GitHub action to generate the client. This will
|
2021-12-06 12:54:24 -08:00
|
|
|
automatically update the client to the latest version based on the
|
|
|
|
|
[spec.yml](spec.yml).
|
2021-12-06 12:43:34 -08:00
|
|
|
|
|
|
|
|
Alternatively, if you wish to generate the client locally, make sure you have
|
|
|
|
|
[Docker installed](https://docs.docker.com/get-docker/) and run:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
$ make generate
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Please do not change the code directly since it is generated. PRs that change
|
|
|
|
|
the code directly will be automatically closed by a bot.
|
