ab-openapi-python-generator 2.1.3__tar.gz

ab_openapi_python_generator-2.1.3/.envrc.example

@@ -0,0 +1,5 @@
+# NOTE: UV_PUBLISH_USERNAME & UV_PUBLISH_PASSWORD are only required for testing
+#       publishing this package from local. However, please let the CD workflow
+#       handle production workflows.
+export UV_PUBLISH_USERNAME=
+export UV_PUBLISH_PASSWORD=

ab_openapi_python_generator-2.1.3/.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "saturday"
+      time: "03:00"
+      timezone: "Australia/Melbourne"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    open-pull-requests-limit: 2
+    schedule:
+      interval: "weekly"
+      day: "saturday"
+      time: "03:00"
+      timezone: "Australia/Melbourne"

ab_openapi_python_generator-2.1.3/.github/workflows/ci.yaml

@@ -0,0 +1,74 @@
+name: CI
+
+permissions:
+  contents: read
+  pull-requests: write
+
+on:
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }} - ci-pipeline"
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    if: ${{ github.actor != 'dependabot[bot]' }}
+    runs-on:
+      group: Default
+    timeout-minutes: 5
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # Install uv + Python (with cache)
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: latest
+          enable-cache: true
+          python-version: "3.12"
+
+      # Private Git deps (optional; remove if not needed)
+      - name: Configure Git credentials for private deps
+        if: env.GH_READ_TOKEN != ''
+        env:
+          GH_READ_TOKEN: ${{ secrets.GH_READ_TOKEN }}
+        run: |
+          git config --global url."https://${GH_READ_TOKEN}:x-oauth-basic@github.com/".insteadOf "https://github.com/"
+
+      - name: Sync deps
+        run: uv sync --extra all
+
+      - name: Lint
+        run: uv run tox -e lint
+
+  test:
+    if: ${{ github.actor != 'dependabot[bot]' }}
+    runs-on:
+      group: Default
+    timeout-minutes: 5
+    # Run in parallel with lint (remove this 'needs' to keep parallel; add needs: [lint] to serialize)
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: latest
+          enable-cache: true
+          python-version: "3.12"
+
+      - name: Configure Git credentials for private deps
+        if: env.GH_READ_TOKEN != ''
+        env:
+          GH_READ_TOKEN: ${{ secrets.GH_READ_TOKEN }}
+        run: |
+          git config --global url."https://${GH_READ_TOKEN}:x-oauth-basic@github.com/".insteadOf "https://github.com/"
+
+      - name: Sync deps
+        run: uv sync --extra all
+
+      - name: Test
+        run: uv run tox -e test

ab_openapi_python_generator-2.1.3/.github/workflows/publish.yaml

@@ -0,0 +1,37 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions: read-all
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.head_ref || github.ref }} - release"
+  cancel-in-progress: true
+
+jobs:
+  publish:
+    runs-on: 
+      group: Default
+    timeout-minutes: 5
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+
+    - name: Install project Python
+      run: uv python install
+
+    - name: Build
+      run: uv build --no-sources
+
+    - name: Publish to PyPI
+      env:
+        UV_PUBLISH_TOKEN: ${{ secrets.UV_PUBLISH_TOKEN }}
+      run: uv publish --verbose

ab_openapi_python_generator-2.1.3/.gitignore

@@ -0,0 +1,219 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+uv.lock
+
+# poetry
+#   For packages, we do not commit the lock file,
+#   since we are not controlling the environment,
+#  refer to https://python-poetry.org/docs/basic-usage/#as-a-library-developer
+poetry.lock
+poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+pdm.lock
+pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+/.idea/
+/testclient/
+/tests/test_result/
+test_output/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+#.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Generated Files
+.DS_Store

ab_openapi_python_generator-2.1.3/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.5
+    hooks:
+      - id: ruff
+        args: [--fix]
+        name: ruff check + fix
+      - id: ruff-format
+        name: ruff format
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        args: ["--write-changes"]
+
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.16
+    hooks:
+      - id: mdformat
+        args: ["--wrap", "80"]
+
+  - repo: https://github.com/pappasam/toml-sort
+    rev: v0.23.1
+    hooks:
+      - id: toml-sort
+        args: ["--all", "--in-place"]

ab_openapi_python_generator-2.1.3/.vscode/launch.json

@@ -0,0 +1,66 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "pytest",
+      "type": "python",
+      "request": "launch",
+      "module": "pytest",
+      "args": ["-vv", "--no-cov"],
+      "justMyCode": false,
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "env": {
+        "PYTHONASYNCIODEBUG": "1" // optional: helps with debugging asyncio
+      }
+    },
+    {
+      "name": "pytest: current module",
+      "type": "python",
+      "request": "launch",
+      "module": "pytest",
+      // run pytest on the directory that contains the file in the active editor
+      "args": ["-vv", "${fileDirname}", "--no-cov"],
+      "justMyCode": false,
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "env": {
+        "PYTHONASYNCIODEBUG": "1" // optional: helps with debugging asyncio
+      }
+    },
+    {
+      "name": "pytest: current file",
+      "type": "python",
+      "request": "launch",
+      "module": "pytest",
+      "args": ["-vv", "${relativeFile}", "--no-cov"],
+      "justMyCode": false,
+      "console": "integratedTerminal",
+      "cwd": "${workspaceFolder}",
+      "env": {
+        "PYTHONASYNCIODEBUG": "1" // optional: helps with debugging asyncio
+      }
+    },
+    {
+      "name": "pytest: specify case in current file",
+      "type": "python",
+      "request": "launch",
+      "module": "pytest",
+      "args": ["-vv", "${relativeFile}::${input:testName}", "--no-cov"],
+      "justMyCode": false,
+      "console": "integratedTerminal",
+      "cwd": "${workspaceFolder}",
+      "env": {
+        "PYTHONASYNCIODEBUG": "1" // optional: helps with debugging asyncio
+      }
+    }
+  ],
+  "inputs": [
+    {
+      "id": "testName",
+      "type": "promptString",
+      "description": "Enter test name or leave blank to run the whole file",
+      "default": ""
+    }
+  ]
+}

ab_openapi_python_generator-2.1.3/.vscode/tasks.json

@@ -0,0 +1,40 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "install",
+            "type": "shell",
+            "command": "make install",
+            "group": "build",
+            "detail": "install required dependencies on bare metal"
+        },
+        {
+            "label": "format",
+            "type": "shell",
+            "command": "make format",
+            "group": "build",
+            "detail": "Run the formatter on bare metal"
+        },
+        {
+            "label": "lint",
+            "type": "shell",
+            "command": "make lint",
+            "group": "build",
+            "detail": "run the linter on bare metal"
+        },
+        {
+            "label": "test",
+            "type": "shell",
+            "command": "make test",
+            "group": "build",
+            "detail": "run unit tests on bare metal"
+        },
+        {
+            "label": "publish",
+            "type": "shell",
+            "command": "make publish",
+            "group": "build",
+            "detail": "Build & publish the package to Nexus"
+        }
+    ]
+}

ab_openapi_python_generator-2.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2022 Marco Müllner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ab_openapi_python_generator-2.1.3/Makefile

@@ -0,0 +1,35 @@
+.DEFAULT_GOAL := help
+SHELL := /bin/bash
+
+
+.PHONY: install ## install required dependencies on bare metal
+install:
+	uv sync --refresh
+
+
+.PHONY: format ## Run the formatter on bare metal
+format:
+	uv run tox -e format
+
+
+.PHONY: lint ## run the linter on bare metal
+lint:
+	uv run tox -e lint
+
+
+.PHONY: test ## run unit tests on bare metal
+test:
+	uv run tox -e test
+
+
+.PHONY: publish ## Build & publish the package to Nexus. Ensure to have UV_PUBLISH_USERNAME & UV_PUBLISH_PASSWORD environment variables set.
+publish:
+	@version=$$(grep '^version *= *' pyproject.toml | head -1 | sed 's/version *= *"\(.*\)"/\1/'); \
+	echo "Current version: $$version"; \
+	read -p "Publish version $$version? (y/n): " confirm; \
+	if [ "$$confirm" = "y" ]; then \
+		uv build --no-sources && \
+		uv publish --verbose; \
+	else \
+		echo "Publish cancelled."; \
+	fi

ab_openapi_python_generator-2.1.3/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: ab-openapi-python-generator
+Version: 2.1.3
+Summary: Openapi Python Generator
+Project-URL: Homepage, https://github.com/auth-broker/openapi-python-generator
+Project-URL: Repository, https://github.com/auth-broker/openapi-python-generator
+Project-URL: Documentation, https://openapi-python-generator.readthedocs.io
+Project-URL: Changelog, https://github.com/auth-broker/openapi-python-generator/releases
+Author-email: Marco Müllner <muellnermarco@gmail.com>, Matt Coulter <mattcoul7@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: Generator,OpenAPI,Python,async
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: <4,>=3.9
+Requires-Dist: black>=21.10b0
+Requires-Dist: click<9,>=8.1.3
+Requires-Dist: httpx[all]<0.29,>=0.28.0
+Requires-Dist: importlib-metadata<9,>=8.7.0
+Requires-Dist: isort>=5.10.1
+Requires-Dist: jinja2<4,>=3.1.2
+Requires-Dist: openapi-pydantic<0.6,>=0.5.1
+Requires-Dist: orjson<4,>=3.9.15
+Requires-Dist: pydantic<3,>=2.10.2
+Requires-Dist: pyyaml<7,>=6.0.2
+Description-Content-Type: text/markdown
+
+# Openapi Python Generator
+
+[![PyPI](https://img.shields.io/pypi/v/openapi-python-generator.svg)][pypi_]
+[![Status](https://img.shields.io/pypi/status/openapi-python-generator.svg)][status]
+[![Python Version](https://img.shields.io/pypi/pyversions/openapi-python-generator)][python version]
+[![License](https://img.shields.io/pypi/l/openapi-python-generator)][license]
+
+[![](https://img.shields.io/static/v1?label=documentation&message=enabled&color=<COLOR>)][documentation]
+[![Tests](https://github.com/auth-broker/openapi-python-generator/workflows/Tests/badge.svg)][tests]
+[![Codecov](https://codecov.io/gh/auth-broker/openapi-python-generator/branch/main/graph/badge.svg)][codecov]
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
+
+[pypi_]: https://pypi.org/project/openapi-python-generator/
+[status]: https://pypi.org/project/openapi-python-generator/
+[python version]: https://pypi.org/project/openapi-python-generator
+[documentation]: https://marcomuellner.github.io/openapi-python-generator/
+[tests]: https://github.com/MarcoMuellner/openapi-python-generator/actions?workflow=Tests
+[codecov]: https://app.codecov.io/gh/MarcoMuellner/openapi-python-generator
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[black]: https://github.com/psf/black
+
+![](logo.png)
+
+---
+__Documentation:__ [here][documentation]
+
+---
+
+## Features
+
+- __Ease of use__. Provide input, output and the library, and the generator will do the rest.
+- __Type safety and type hinting.__ __OpenAPI python generator__ makes heavy use of pydantic models to provide type-safe data structures.
+- __Support for multiple rest frameworks.__ __OpenAPI python generator__ currently supports the following:
+    - [httpx](https://pypi.org/project/httpx/)
+    - [requests](https://pypi.org/project/requests/)
+    - [aiohttp](https://pypi.org/project/aiohttp/)
+- __Async and sync code generation support__, depending on the framework. It will automatically create both for frameworks that support both.
+- __Easily extendable using Jinja2 templates__. The code is designed to be easily extendable and should support even more languages and frameworks in the future.
+- __Fully tested__. Every generated code is automatically tested against the OpenAPI spec and we have 100% coverage.
+- __Usage as CLI or as library__.
+
+## Requirements
+
+- Python 3.7+
+
+## Installation
+
+You can install _Openapi Python Generator_ via [pip] from [PyPI]:
+
+```console
+$ pip install ab-openapi-python-generator
+```
+
+## Usage
+
+Please see the [Quick start page] for details.
+
+## Roadmap
+
+- Support for all commonly used http libraries in the python ecosystem (~~requests~~, urllib, ...)
+- Support for multiple languages
+- Support for multiple authentication schemes
+- Support custom themes
+
+## Contributing
+
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
+
+## License
+
+Distributed under the terms of the [MIT license][license],
+_Openapi Python Generator_ is free and open source software.
+
+## Issues
+
+If you encounter any problems,
+please [file an issue] along with a detailed description.
+
+## Credits
+
+Special thanks to the peeps from [openapi-schema-pydantic](https://github.com/kuimono/openapi-schema-pydantic),
+which already did a lot of the legwork by providing a pydantic schema for the OpenAPI 3.0.0+ specification.
+
+This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.
+
+[@cjolowicz]: https://github.com/cjolowicz
+[pypi]: https://pypi.org/
+[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
+[file an issue]: https://github.com/MarcoMuellner/openapi-python-generator/issues
+[pip]: https://pip.pypa.io/
+
+<!-- github-only -->
+
+[license]: https://github.com/MarcoMuellner/openapi-python-generator/blob/main/LICENSE
+[contributor guide]: https://github.com/MarcoMuellner/openapi-python-generator/blob/main/CONTRIBUTING.md
+[Quick start page]: https://marcomuellner.github.io/openapi-python-generator/quick_start/