https://github.com/alexdemure/fastclient
A CLI tool that generates HTTP clients from an OpenAPI specification
https://github.com/alexdemure/fastclient
http-client openapi-client python-client python-openapi
Last synced: 9 months ago
JSON representation
A CLI tool that generates HTTP clients from an OpenAPI specification
- Host: GitHub
- URL: https://github.com/alexdemure/fastclient
- Owner: AlexDemure
- License: mit
- Created: 2025-03-25T15:35:07.000Z (9 months ago)
- Default Branch: production
- Last Pushed: 2025-04-01T11:17:19.000Z (9 months ago)
- Last Synced: 2025-04-01T11:43:24.341Z (9 months ago)
- Topics: http-client, openapi-client, python-client, python-openapi
- Language: Python
- Homepage:
- Size: 1000 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A CLI tool that generates HTTP clients from an OpenAPI specification.
---
## Installation
```
pip install fastclientoas
```
## Usage
Run the code generation process:
```sh
fastclient --file {config.toml} --context "{}"
```
## Configuration File Guide
Fastclient uses a structured TOML configuration file.
### General Structure
```
workdir = "myproject"
[[clients]]
path = "{{name}}.py"
content = "file:openapi.json"
model = "pydantic"
async = true
operations = []
[[scripts]]
command = "isort {{workdir}}"
check = true
```
### Sections Overview
| Section | Format | Description | | |
|---------------|--------------------------------------|--------------------------------------------------------------------------|---|---|
| `workdir` | `""` | Uses the current directory | | |
| | `"myproject"` | Uses the current directory + `/myproject` | | |
| | `"/home/myproject"` | Uses an absolute path | | |
| `[[clients]]` | | Defines file creation rules | | |
| | `mode = "a"` | File writing mode: `"a"` (append), `"w"` (overwrite) | | |
| | `path = "src/__init__.py"` | Relative to workdir, specifies file location. | | |
| | `content = """ ... """ / path / url` | Raw content, local file path, or URL for remote content. | | |
| | `model = "pydantic"` | Type of models created | | |
| | `async = "true"` | Type of methods | | |
| | `operations = []` | Filtering methods by operation_id | | |
| `[[scripts]]` | | Defines commands to be executed after generation. | | |
| | `command = "isort {{workdir}}"` | Command to execute, supports dynamic variables. | | |
| | `check = True\False"` | If true, raises an error if the command fails, otherwise logs output. | | |
## Using Dynamic Variables
Fastclient supports dynamic variables in both file paths, contents, and script commands.
```toml
[[clients]]
path = "src/{{name}}.py
```
## Automating Post-Generation Tasks
Fastclient allows you to execute scripts after generating files. These scripts can perform tasks such as formatting, linting, or additional file modifications.
#### Example
```
[[scripts]]
command = "isort {{workdir}}"
check = true
[[scripts]]
command = "ruff {{workdir}} --fix"
check = false
```
- Commands support dynamic variables.
- If check = true, the execution will fail if the command returns a non-zero exit code.
