{"id":20522418,"url":"https://github.com/openapi-generators/openapi-python-client-action","last_synced_at":"2025-04-14T03:02:36.613Z","repository":{"id":43455083,"uuid":"329658527","full_name":"openapi-generators/openapi-python-client-action","owner":"openapi-generators","description":"GitHub Action to generate a python client package from an openapi spec","archived":false,"fork":false,"pushed_at":"2024-10-23T16:07:27.000Z","size":13,"stargazers_count":9,"open_issues_count":3,"forks_count":4,"subscribers_count":2,"default_branch":"v2","last_synced_at":"2025-03-27T16:56:11.352Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openapi-generators.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-14T15:38:47.000Z","updated_at":"2025-02-01T18:57:41.000Z","dependencies_parsed_at":"2024-05-20T20:09:43.993Z","dependency_job_id":"c02fcb42-05ab-42d8-942f-89ca2e5bc5e3","html_url":"https://github.com/openapi-generators/openapi-python-client-action","commit_stats":{"total_commits":14,"total_committers":6,"mean_commits":"2.3333333333333335","dds":0.6428571428571428,"last_synced_commit":"ef7e121939d7449e82caa9878a5ba77d7498dd1e"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openapi-generators%2Fopenapi-python-client-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openapi-generators%2Fopenapi-python-client-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openapi-generators%2Fopenapi-python-client-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openapi-generators%2Fopenapi-python-client-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openapi-generators","download_url":"https://codeload.github.com/openapi-generators/openapi-python-client-action/tar.gz/refs/heads/v2","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248813789,"owners_count":21165633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T22:35:25.998Z","updated_at":"2025-04-14T03:02:36.587Z","avatar_url":"https://github.com/openapi-generators.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# openapi-python-client-action\nThe official GitHub Action for [openapi-python-client](https://github.com/openapi-generators/openapi-python-client) - generates a modern Python client package from an OpenAPI document\n\n## Inputs\n\n### `openapi-python-client-version`\n\nThe version of the openapi-python-client package to use. If unspecified the latest released version will be used. **Version 2 of this action only supports version 0.9.0+ of the generator. Use version 1 of this action for older versions of the generator.**\n\n### `openapi-file`\n\nThe path (with respect to the current directory/the workspace) to the OpenAPI document (both JSON and YAML are supported). Defaults to just \"openapi.json\" i.e. a file in the current directory called openapi.json.\n\n### `openapi-url`\n\nThe url of the OpenAPI document. Overrides `openapi-file` - If unspecified the value of the `openapi-file` input (which defaults to just `openapi.json`) will be used to generate the client.\n\n### `config-file`\n\nThe path (with respect to the current directory/the workspace) to the config.yml to be used with openapi-python-client. Configuaration is not required so if this is unspecified then no configuration will be passed along. See [openapi-python-client's README](https://github.com/openapi-generators/openapi-python-client#configuration) for available configuration\n\n### `extra-args`\n\nThis is a catch-all to allow you to pass additional arguments to `openapi-python-client`.\n\n## Outputs\n\nNo outputs are returned.\nThe generated client is placed in the current directory. The name of the package (unless configured differently) will be `title-client` where \"title\" comes from the field with the same name within the `info` section of the openapi document.\n\n## Example usage\n```yaml\njobs:\n  generate-python-client:\n    runs-on: ubuntu-latest\n    name: Example\n    steps:\n\n      # Checkout your code\n      - name: Checkout\n        uses: actions/checkout@v2\n\n      # Generate your openapi document (if you don't write it manually)\n\n      # Use the action to generate a client package\n      # This uses all defaults (latest version, openapi.json in the current workspace, no configuration)\n      - name: Generate Python Client\n        uses: openapi-generators/openapi-python-client-action@v2\n\n      # Do something with the generated client (likely publishing it somewhere)\n      # Here we assume that the info/title in the openapi document was \"example-project\"\n      - name: Do something with the client\n        run: |\n          cd example-project-client\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenapi-generators%2Fopenapi-python-client-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenapi-generators%2Fopenapi-python-client-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenapi-generators%2Fopenapi-python-client-action/lists"}