📝 Use Clientele
Note
You can type clientele COMMAND --help at anytime to see explicit information about the available arguments.
generate
Generate a Python HTTP Client from an OpenAPI Schema.
From a URL
Use the -u or --url argument.
-o or --output is the target directory for the generate client.
clientele generate -u https://raw.githubusercontent.com/phalt/clientele/main/example_openapi_specs/best.json -o my_client/
Note
The example above uses one of our test schemas, and will work if you copy/paste it!
From a file
Alternatively you can provide a local file using the -f or --file argument.
Async.io
If you prefer an asyncio client, just pass --asyncio t to your command.
Regenerating
At times you may wish to regenerate the client. This could be because the API has updated or you just want to use a newer version of clientele.
To force a regeneration you must pass the --regen or -r argument, for example:
Note
You can copy and paste the command from the MANIFEST.md file in your previously-generated client for a quick and easy regeneration.
validate
Validate lets you check if an OpenAPI schema will work with clientele.
Note
Some OpenAPI schema generators do not conform to the specification.
Clientele uses openapi-core to validate the schema.
From a URL
Use the -u or --url argument.
-o or --output is the target directory for the generate client.
From a file path
Alternatively you can provide a local file using the -f or --file argument.
generate-basic
The generate-basic command can be used to generate a basic file structure for an HTTP client.
It does not required an OpenAPI schema, just a path.
This command serves two reasons:
- You may have an HTTP API without an OpenAPI schema and you want to keep a consistent file structure with other Clientele clients.
- The generator for this basic client can be extended for your own client in the future, if you choose.
version
Print the current version of Clientele: