-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
don't build python with project; add documentation
- Loading branch information
1 parent
0a117db
commit 170d37c
Showing
2 changed files
with
17 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Teaspoons CLI | ||
|
||
## Python thin client auto-generation | ||
We use the [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) to generate the "thin" Python client, | ||
which is then used to build the Python-based "thick" CLI tool. | ||
|
||
To generate the Python thin client, run the following command: | ||
```bash | ||
./gradlew :teaspoons-cli:openApiGenerate | ||
``` | ||
|
||
This will produce generated files at `/teaspoons-cli/build/`. | ||
|
||
Note we do not run the openApiGenerate task as part of the main Teaspoons build, as it is not necessary for the | ||
service itself and we don't want any potential bugs in the CLI to affect the service. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters