feat: Add --meta uv for generating astral-sh/uv compatible packages.

Resolves #1241

Author: alexandervaneck-paige

.gitignore

@@ -36,4 +36,5 @@ htmlcov/
 # Generated end to end test data
 my-test-api-client/
 custom-e2e/
-3-1-features-client
+3-1-features-client
+tests/tmp

end_to_end_tests/metadata_snapshots/uv.pyproject.toml

@@ -0,0 +1,36 @@
+[project]
+name = "test-3-1-features-client"
+version = "0.1.0"
+description = "A client library for accessing Test 3.1 Features"
+authors = []
+requires-python = "~=3.9"
+readme = "README.md"
+dependencies = [
+    "httpx>=0.23.0,<0.29.0",
+    "attrs>=22.2.0",
+    "python-dateutil>=2.8.0,<3",
+]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "test_3_1_features_client",
+    "CHANGELOG.md",
+    "test_3_1_features_client/py.typed",
+]
+
+[tool.hatch.build.targets.wheel]
+include = [
+    "test_3_1_features_client",
+    "CHANGELOG.md",
+    "test_3_1_features_client/py.typed",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["F", "I", "UP"]

end_to_end_tests/regen_golden_record.py

@@ -73,7 +73,7 @@ def regen_metadata_snapshots():
     output_path = Path.cwd() / "test-3-1-features-client"
     snapshots_dir = Path(__file__).parent / "metadata_snapshots"
 
-    for (meta, file, rename_to) in (("setup", "setup.py", "setup.py"), ("pdm", "pyproject.toml", "pdm.pyproject.toml"), ("poetry", "pyproject.toml", "poetry.pyproject.toml")):
+    for (meta, file, rename_to) in (("setup", "setup.py", "setup.py"), ("pdm", "pyproject.toml", "pdm.pyproject.toml"), ("poetry", "pyproject.toml", "poetry.pyproject.toml"), ("uv", "pyproject.toml", "uv.pyproject.toml")):
         _regenerate(
             spec_file_name="3.1_specific.openapi.yaml",
             output_dir="test-3-1-features-client",

end_to_end_tests/test_end_to_end.py

@@ -143,6 +143,7 @@ def test_literal_enums_end_to_end():
         ("setup", "setup.py", "setup.py"),
         ("pdm", "pyproject.toml", "pdm.pyproject.toml"),
         ("poetry", "pyproject.toml", "poetry.pyproject.toml"),
+        ("uv", "pyproject.toml", "uv.pyproject.toml"),
     )
 )
 def test_meta(meta: str, generated_file: Optional[str], expected_file: Optional[str]):
@@ -284,7 +285,7 @@ def test_update_integration_tests():
         import mypy.api
 
         out, err, status = mypy.api.run([str(temp_dir), "--strict"])
-        assert status == 0, f"Type checking client failed: {out}"
+        assert status == 0, f"Type checking client failed: {out=} {err=}"
 
     finally:
         shutil.rmtree(temp_dir)

openapi_python_client/__init__.py

@@ -184,7 +184,7 @@ def _build_metadata(self) -> None:
         readme = self.project_dir / "README.md"
         readme_template = self.env.get_template("README.md.jinja")
         readme.write_text(
-            readme_template.render(poetry=self.config.meta_type == MetaType.POETRY),
+            readme_template.render(meta=self.config.meta_type),
             encoding=self.config.file_encoding,
         )
 

openapi_python_client/config.py

@@ -26,6 +26,7 @@ class MetaType(str, Enum):
     POETRY = "poetry"
     SETUP = "setup"
     PDM = "pdm"
+    UV = "uv"
 
 
 class ConfigFile(BaseModel):

openapi_python_client/templates/README.md.jinja

@@ -109,7 +109,7 @@ client = Client(
 client.set_httpx_client(httpx.Client(base_url="https://api.example.com", proxies="http://localhost:8030"))
 ```
 
-{% if poetry %}
+{% if meta == "poetry" %}
 ## Building / publishing this package
 This project uses [Poetry](https://python-poetry.org/) to manage dependencies  and packaging.  Here are the basics:
 1. Update the metadata in pyproject.toml (e.g. authors, version)
@@ -123,4 +123,17 @@ If you want to install this client into another project without publishing it (e
 1. If that project is not using Poetry:
     1. Build a wheel with `poetry build -f wheel`
     1. Install that wheel from the other project `pip install <path-to-wheel>`
+{% elif meta == 'uv' %}
+## Building / publishing this package
+This project uses [uv](https://github.com/astral-sh/uv) to manage dependencies and packaging. Here are the basics:
+1. Update the metadata in `pyproject.toml` (e.g. authors, version).
+2. If you're using a private repository: https://docs.astral.sh/uv/guides/integration/alternative-indexes/
+3. Build a distribution with `uv build`, builds `sdist` and `wheel` by default.
+1. Publish the client with `uv publish`, see documentation for publishing to private indexes.
+
+If you want to install this client into another project without publishing it (e.g. for development) then:
+1. If that project **is using uv**, you can simply do `uv add <path-to-this-client>` from that project
+1. If that project is not using uv:
+    1. Build a wheel with `uv build --wheel`.
+    1. Install that wheel from the other project `pip install <path-to-wheel>`.
 {% endif %}

openapi_python_client/templates/pyproject.toml.jinja

@@ -1,9 +1,9 @@
-{% set poetry = meta == "poetry" %}
-{% set pdm = meta == "pdm" %}
-{% if poetry %}
+{% if meta == "poetry" %}
 {% include "pyproject_poetry.toml.jinja" %}
-{% elif pdm %}
+{% elif meta == "pdm" %}
 {% include "pyproject_pdm.toml.jinja" %}
+{% elif meta == "uv" %}
+{% include "pyproject_uv.toml.jinja" %}
 {% endif %}
 
 {% include "pyproject_ruff.toml.jinja" %}

openapi_python_client/templates/pyproject_uv.toml.jinja

@@ -0,0 +1,30 @@
+[project]
+name = "{{ project_name }}"
+version = "{{ package_version }}"
+description = "{{ package_description }}"
+authors = []
+requires-python = "~=3.9"
+readme = "README.md"
+dependencies = [
+    "httpx>=0.23.0,<0.29.0",
+    "attrs>=22.2.0",
+    "python-dateutil>=2.8.0,<3",
+]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "{{ package_name }}",
+    "CHANGELOG.md",
+    "{{ package_name }}/py.typed",
+]
+
+[tool.hatch.build.targets.wheel]
+include = [
+    "{{ package_name }}",
+    "CHANGELOG.md",
+    "{{ package_name }}/py.typed",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"