Support PDM (#920)

A couple of things drive this change—first, PEP621 has been around for a
while now and Poetry shows no signs of adopting it, so while I don't
want to ditch Poetry support (it's very popular), I do want a way to
generate that style of metadata. PDM seems like a good target for that.

Second, Poetry has deprecated some plugins we use... or something. I
didn't look into it, but we're getting warnings on every project build
now. So, seems like time to switch over to something else. Conveniently,
this will make the development commands shorter (`poetry run task check`
becomes `pdm check`).

TODO:

- [x] Convert this project to PDM
- [x] Support PDM metadata (which is partially [PEP
621](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#writing-pyproject-toml))
- [x] Update release workflows to use PDM as well
- [x] Document using PDM metadata in README
- [x] Double-check that `py.typed` is included with a generated PDM
project
- [x] Add snapshot tests for different metadata types and test them as
much as possible

---------

Co-authored-by: Dylan Anthony <[email protected]>

Author: dbanty

.changeset/add_metapdm_option_for_generating_pep621_pdm_metadata.md

@@ -0,0 +1,10 @@
+---
+default: minor
+---
+
+# Add `--meta=pdm` option for generating PEP621 + PDM metadata
+
+The default metadata is still `--meta=poetry`, which generates a `pyproject.toml` file with Poetry-specific metadata.
+This change adds the `--meta=pdm` option which includes [PDM](https://pdm-project.org/latest/)-specific metadata, but also 
+standard [PEP621](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#writing-pyproject-toml)
+metadata. This may be useful as a starting point for other dependency managers & build tools (like Hatch).

.github/workflows/checks.yml

@@ -30,42 +30,36 @@ jobs:
         uses: actions/cache@v3
         with:
           path: .venv
-          key: ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-dependencies-${{ hashFiles('**/poetry.lock') }}
+          key: ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-dependencies-${{ hashFiles('**/pdm.lock') }}
           restore-keys: |
             ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-dependencies
-      - name: Install Poetry
-        run: pip install poetry
-
-      - name: Create Virtual Environment
-        run: python -m venv .venv
-
-      - name: Upgrade pip
-        run: poetry run python -m pip install --upgrade pip
+      - name: Install PDM
+        run: pip install pdm
 
       - name: Install Dependencies
-        run: poetry install
+        run: pdm install
 
       - name: Check formatting
-        run: poetry run ruff format . --check
+        run: pdm run ruff format . --check
 
       - name: Run safety
-        run: poetry export -f requirements.txt | poetry run safety check --bare --stdin
+        run: pdm safety_check
 
       - name: Run mypy
-        run: poetry run mypy --show-error-codes openapi_python_client
+        run: pdm mypy --show-error-codes
 
       - name: Lint
-        run: poetry run ruff check .
+        run: pdm run ruff check .
 
       - name: Run pytest without coverage
         if: matrix.os != 'ubuntu-latest'
-        run: poetry run pytest tests end_to_end_tests/test_end_to_end.py --basetemp=tests/tmp
+        run: pdm test
         env:
           TASKIPY: true
 
       - name: Run pytest with coverage
         if: matrix.os == 'ubuntu-latest'
-        run: poetry run pytest --cov=openapi_python_client --cov-report=term-missing tests end_to_end_tests/test_end_to_end.py --basetemp=tests/tmp
+        run: pdm test_with_coverage
         env:
           TASKIPY: true
 
@@ -147,42 +141,37 @@ jobs:
         uses: actions/cache@v3
         with:
           path: .venv
-          key: ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-dependencies-${{ hashFiles('**/poetry.lock') }}
+          key: ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-dependencies-${{ hashFiles('**/pdm.lock') }}
           restore-keys: |
             ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-dependencies
       - name: Install dependencies
         run: |
-          pip install poetry
+          pip install pdm
           python -m venv .venv
-          poetry run python -m pip install --upgrade pip
-          poetry install
+          pdm install
       - name: Regenerate Integration Client
         run: |
-          poetry run openapi-python-client update --url http://localhost:3000/openapi.json --config integration-tests-config.yaml
+          pdm run openapi-python-client update --url http://localhost:3000/openapi.json --config integration-tests-config.yaml --meta pdm
       - name: Check for any file changes
         run: python .github/check_for_changes.py
       - name: Cache Generated Client Dependencies
         uses: actions/cache@v3
         with:
           path: integration-tests/.venv
-          key: ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-integration-dependencies-${{ hashFiles('**/poetry.lock') }}
+          key: ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-integration-dependencies-${{ hashFiles('**/pdm.lock') }}
           restore-keys: |
             ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-integration-dependencies
-      - name: Install Integration Dependencies
-        run: |
-          cd integration-tests
-          python -m venv .venv
-          poetry run python -m pip install --upgrade pip
-          poetry install
       - name: Set httpx version
         if: matrix.httpx_version != ''
         run: |
           cd integration-tests 
-          poetry run pip install httpx==${{ matrix.httpx_version }}
+          pdm add httpx==${{ matrix.httpx_version }}
+      - name: Install Integration Dependencies
+        run: |
+          cd integration-tests
+          pdm install
       - name: Run Tests
         run: |
           cd integration-tests
-          poetry run pytest
-          poetry run mypy . --strict
-  
-  
+          pdm run pytest
+          pdm run mypy . --strict

.github/workflows/release.yml

@@ -9,6 +9,8 @@ jobs:
   release:
     if: github.head_ref == 'release' && github.event.pull_request.merged == true
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
     steps:
       - uses: actions/[email protected]
         with:
@@ -18,10 +20,12 @@ jobs:
         uses: knope-dev/[email protected]
         with:
           version: 0.13.3
-      - name: Install Poetry
-        run: pip install --upgrade poetry
+      - name: Install Hatchling
+        run: pip install --upgrade hatchling
+      - name: Build
+        run: hatchling build
       - name: Push to PyPI
-        run: poetry publish --build -u __token__ -p ${{ secrets.PYPI_TOKEN }}
+        uses: pypa/[email protected]
       - name: Create GitHub Release
         run: knope release
         env:

.gitignore

@@ -1,9 +1,13 @@
+.pdm-python
 __pycache__/
 build/
 dist/
 *.egg-info/
 .pytest_cache/
 
+# macOS
+.DS_Store
+
 # pyenv
 .python-version
 

CONTRIBUTING.md

@@ -40,10 +40,9 @@ To request a feature:
 
 ### Setting up a Dev Environment
 
-1. Make sure you have [Poetry](https://python-poetry.org/) installed and up to date.
-2. Make sure you have a supported Python version (e.g. 3.8) installed and accessible to Poetry (e.g. with [pyenv](https://github.com/pyenv/pyenv)).
-3. Use `poetry install` in the project directory to create a virtual environment with the relevant dependencies.
-4. Enter a `poetry shell` to make running commands easier.
+1. Make sure you have [PDM](https://pdm-project.org) installed and up to date.
+2. Make sure you have a supported Python version (e.g. 3.8) installed.
+3. Use `pdm install` in the project directory to create a virtual environment with the relevant dependencies.
 
 ### Writing tests
 
@@ -57,7 +56,7 @@ If you think that some of the added code is not testable (or testing it would ad
 
 #### End-to-end tests
 
-This project aims to have all "happy paths" (types of code which _can_ be generated) covered by end to end tests (snapshot tests). In order to check code changes against the previous set of snapshots (called a "golden record" here), you can run `poetry run task e2e`. To regenerate the snapshots, run `poetry run task regen`.
+This project aims to have all "happy paths" (types of code which _can_ be generated) covered by end to end tests (snapshot tests). In order to check code changes against the previous set of snapshots (called a "golden record" here), you can run `pdm e2e`. To regenerate the snapshots, run `pdm regen`.
 
 There are 4 types of snapshots generated right now, you may have to update only some or all of these depending on the changes you're making. Within the `end_to_end_tets` directory:
 

README.md

@@ -26,7 +26,7 @@ This tool focuses on creating the best developer experience for Python developer
 
 I recommend you install with [pipx](https://pipxproject.github.io/pipx/) so you don't conflict with any other packages you might have: `pipx install openapi-python-client --include-deps`.
 
-> Note the `--include-deps` option which will also make `black` and `ruff` available in your path so that `openapi-python-client` can use them to clean up the generated code.
+> Note the `--include-deps` option makes `ruff` available in your path so that `openapi-python-client` can use it to clean up the generated code.
 
 **If you use `pipx run` then the post-generation hooks will not be available unless you install them manually.**
 
@@ -52,8 +52,6 @@ If you have an `openapi.json` file available on disk, in any CLI invocation you
 
 `openapi-python-client update --url https://my.api.com/openapi.json`
 
-> For more usage details run `openapi-python-client --help` or read [usage](usage.md)
-
 ### Using custom templates
 
 This feature leverages Jinja2's [ChoiceLoader](https://jinja.palletsprojects.com/en/2.11.x/api/#jinja2.ChoiceLoader) and [FileSystemLoader](https://jinja.palletsprojects.com/en/2.11.x/api/#jinja2.FileSystemLoader). This means you do _not_ need to customize every template. Simply copy the template(s) you want to customize from [the default template directory](openapi_python_client/templates) to your own custom template directory (file names _must_ match exactly) and pass the template directory through the `custom-template-path` flag to the `generate` and `update` commands. For instance,
@@ -68,14 +66,15 @@ _Be forewarned, this is a beta-level feature in the sense that the API exposed i
 
 ## What You Get
 
-1. A `pyproject.toml` file with some basic metadata intended to be used with [Poetry].
+1. A `pyproject.toml` file, optionally with [Poetry] metadata (default), [PDM] (with `--meta=pdm`), or only [Ruff] config.
 2. A `README.md` you'll most definitely need to update with your project's details
 3. A Python module named just like the auto-generated project name (e.g. "my_api_client") which contains:
    1. A `client` module which will have both a `Client` class and an `AuthenticatedClient` class. You'll need these
       for calling the functions in the `api` module.
    2. An `api` module which will contain one module for each tag in your OpenAPI spec, as well as a `default` module
       for endpoints without a tag. Each of these modules in turn contains one function for calling each endpoint.
    3. A `models` module which has all the classes defined by the various schemas in your OpenAPI spec
+4. A `setup.py` file _if_ you use `--meta=setup` (default is `--meta=poetry`)
 
 For a full example you can look at the `end_to_end_tests` directory which has `baseline_openapi_3.0.json` and `baseline_openapi_3.1.yaml` files.
 The "golden-record" in that same directory is the generated client from either of those OpenAPI documents.
@@ -137,7 +136,7 @@ package_version_override: 1.2.3
 
 ### post_hooks
 
-In the config file, there's an easy way to tell `openapi-python-client` to run additional commands after generation. Here's an example showing the default commands that will run if you don't override them in config:
+In the config file, there's an easy way to tell `openapi-python-client` to run additional commands after generation. Here's an example showing the default commands (using [Ruff]) that will run if you don't override them in config:
 
 ```yaml
 post_hooks:
@@ -159,3 +158,5 @@ By default, the timeout for retrieving the schema file via HTTP is 5 seconds. In
 
 [changelog.md]: CHANGELOG.md
 [poetry]: https://python-poetry.org/
+[PDM]: https://pdm-project.org/latest/
+[Ruff]: https://docs.astral.sh/ruff/

end_to_end_tests/golden-record/pyproject.toml

@@ -2,15 +2,14 @@
 name = "my-test-api-client"
 version = "0.1.0"
 description = "A client library for accessing My Test API"
-
 authors = []
-
 readme = "README.md"
 packages = [
     {include = "my_test_api_client"},
 ]
 include = ["CHANGELOG.md", "my_test_api_client/py.typed"]
 
+
 [tool.poetry.dependencies]
 python = "^3.8"
 httpx = ">=0.20.0,<0.27.0"

end_to_end_tests/metadata_snapshots/pdm.pyproject.toml

@@ -0,0 +1,23 @@
+[project]
+name = "test-3-1-features-client"
+version = "0.1.0"
+description = "A client library for accessing Test 3.1 Features"
+authors = []
+readme = "README.md"
+requires-python = ">=3.8,<4.0"
+dependencies = [
+    "httpx>=0.20.0,<0.27.0",
+    "attrs>=21.3.0",
+    "python-dateutil>=2.8.0",
+]
+
+[tool.pdm]
+package-type = "library"
+
+[build-system]
+requires = ["pdm-backend"]
+build-backend = "pdm.backend"
+
+[tool.ruff]
+select = ["F", "I"]
+line-length = 120

end_to_end_tests/metadata_snapshots/poetry.pyproject.toml

@@ -0,0 +1,25 @@
+[tool.poetry]
+name = "test-3-1-features-client"
+version = "0.1.0"
+description = "A client library for accessing Test 3.1 Features"
+authors = []
+readme = "README.md"
+packages = [
+    {include = "test_3_1_features_client"},
+]
+include = ["CHANGELOG.md", "test_3_1_features_client/py.typed"]
+
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = ">=0.20.0,<0.27.0"
+attrs = ">=21.3.0"
+python-dateutil = "^2.8.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+select = ["F", "I"]
+line-length = 120

end_to_end_tests/metadata_snapshots/setup.py

@@ -0,0 +1,18 @@
+import pathlib
+
+from setuptools import find_packages, setup
+
+here = pathlib.Path(__file__).parent.resolve()
+long_description = (here / "README.md").read_text(encoding="utf-8")
+
+setup(
+    name="test-3-1-features-client",
+    version="0.1.0",
+    description="A client library for accessing Test 3.1 Features",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    packages=find_packages(),
+    python_requires=">=3.8, <4",
+    install_requires=["httpx >= 0.20.0, < 0.27.0", "attrs >= 21.3.0", "python-dateutil >= 2.8.0, < 3"],
+    package_data={"test_3_1_features_client": ["py.typed"]},
+)

end_to_end_tests/regen_golden_record.py

@@ -51,6 +51,26 @@ def regen_golden_record_3_1_features():
     output_path.rename(gr_path)
 
 
+def regen_metadata_snapshots():
+    runner = CliRunner()
+    openapi_path = Path(__file__).parent / "3.1_specific.openapi.yaml"
+    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")):
+        shutil.rmtree(output_path, ignore_errors=True)
+        result = runner.invoke(app, ["generate", f"--path={openapi_path}", f"--meta={meta}"])
+
+        if result.stdout:
+            print(result.stdout)
+        if result.exception:
+            raise result.exception
+
+        (output_path / file).rename(snapshots_dir / rename_to)
+
+    shutil.rmtree(output_path, ignore_errors=True)
+
+
 def regen_custom_template_golden_record():
     runner = CliRunner()
     openapi_path = Path(__file__).parent / "baseline_openapi_3.0.json"
@@ -104,4 +124,5 @@ def regen_custom_template_golden_record():
 if __name__ == "__main__":
     regen_golden_record()
     regen_golden_record_3_1_features()
+    regen_metadata_snapshots()
     regen_custom_template_golden_record()

end_to_end_tests/test-3-1-golden-record/pyproject.toml

@@ -2,15 +2,14 @@
 name = "test-3-1-features-client"
 version = "0.1.0"
 description = "A client library for accessing Test 3.1 Features"
-
 authors = []
-
 readme = "README.md"
 packages = [
     {include = "test_3_1_features_client"},
 ]
 include = ["CHANGELOG.md", "test_3_1_features_client/py.typed"]
 
+
 [tool.poetry.dependencies]
 python = "^3.8"
 httpx = ">=0.20.0,<0.27.0"