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
|
|
|
|
2021-12-14 18:19:40 -08:00
|
|
|
- [PyPI](https://pypi.org/project/kittycad/)
|
2021-12-15 02:08:42 -08:00
|
|
|
- [Python docs](https://python.api.docs.kittycad.io/)
|
2021-12-14 18:19:40 -08:00
|
|
|
- [KittyCAD API Docs](https://docs.kittycad.io/?lang=python)
|
|
|
|
|
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-08 08:47:49 -08:00
|
|
|
automatically update the client to the latest version based on the spec hosted
|
|
|
|
at [api.kittycad.io](https://api.kittycad.io/).
|
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.
|