Generate entry_points.txt in built wheels (#46)

Author: czoido

.github/workflows/ci.yml

@@ -125,12 +125,15 @@ jobs:
           python -c "import extra_utils; assert extra_utils.add(2, 3) == 5"
           python -c "import myadder_nanobind; assert myadder_nanobind.add(2, 3) == 5; assert myadder_nanobind.add_integers(10, 20) == 30; assert myadder_nanobind.greet('World').startswith('Hello'); print('myadder_nanobind OK')"
           python -c "import hello_bindings; hello_bindings.hello(); print('hello_bindings OK')"
+          myadder add 2 3 | grep -q "= 5"
+          myadder greet World | grep -q "Hello"
         shell: bash
       - name: Test editable package
         run: |
           pip uninstall -y myadder_pybind11
           pip install -e examples/basic-pybind11 --no-build-isolation
           python -c "import myadder_pybind11; assert myadder_pybind11.add(2, 3) == 5; assert myadder_pybind11.add_integers(10, 20) == 30; assert myadder_pybind11.greet('World').startswith('Hello'); print('myadder_pybind11 OK')"
+          myadder add 2 3 | grep -q "= 5"
         shell: bash
       - name: Upload wheels
         uses: actions/upload-artifact@v4

docs/configuration.md

@@ -119,6 +119,32 @@ or `CONAN_HOME` / `.conanrc`). Set
 `CONAN_PY_BUILD_PROFILE_AUTODETECT=1` to autodetect
 the profile instead of requiring `default`.
 
+## Entry points (PEP 621)
+
+`[project.scripts]`, `[project.gui-scripts]` and
+`[project.entry-points.*]` from `pyproject.toml` are
+written to `<pkg>.dist-info/entry_points.txt` in the
+wheel, per the PyPA
+[entry points specification](https://packaging.python.org/en/latest/specifications/entry-points/).
+Installers create the corresponding console/GUI
+wrappers at install time; runtime tools like
+`importlib.metadata.entry_points()` read them
+from this file.
+
+```toml
+[project.scripts]
+mycli = "mypackage.cli:main"
+
+[project.gui-scripts]
+mygui = "mypackage.gui:run"
+
+[project.entry-points."myplugin.hooks"]
+on_event = "mypackage.hooks:on_event"
+```
+
+The file is only written when at least one entry
+point is declared.
+
 ## License files (PEP 639)
 
 Set `license-files` in `[project]`

examples/basic-pybind11/README.md

@@ -2,6 +2,15 @@
 
 Example of a Python package with C++ code using **pybind11**.
 
+Showcases PEP 621 features wired through the backend: dynamic
+`version`, PEP 639 license files, and a [`project.scripts`][ep]
+entry that installs the `myadder` CLI as a real executable.
+Custom plugin-discovery groups (`[project.entry-points."…"]`)
+are also supported — see the
+[backend docs](https://conan-py-build.conan.io/configuration/).
+
+[ep]: https://packaging.python.org/en/latest/specifications/entry-points/
+
 ## Build and Install
 
 ```bash
@@ -25,6 +34,11 @@ pip install dist/myadder_pybind11-*.whl
 # Test it
 python -c "import myadder_pybind11; print(myadder_pybind11.add(2, 3)); print(myadder_pybind11.add_integers(10, 20)); print(myadder_pybind11.greet('World'))"
 
+# Console script installed automatically via [project.scripts]
+myadder add 2 3
+myadder add-int 10 20
+myadder greet World
+
 # Uninstall when done
 pip uninstall myadder-pybind11 -y
 ```

examples/basic-pybind11/pyproject.toml

@@ -10,6 +10,9 @@ license = "MIT"
 license-files = ["LICENSE"]
 requires-python = ">=3.8"
 
+[project.scripts]
+myadder = "myadder_pybind11.cli:main"
+
 [tool.conan-py-build.version]
 file = "python/myadder_pybind11/__init__.py"
 

examples/basic-pybind11/python/myadder_pybind11/cli.py

@@ -0,0 +1,35 @@
+"""CLI for myadder_pybind11; wired via [project.scripts] in pyproject.toml."""
+import argparse
+import sys
+
+from myadder_pybind11 import add, add_integers, greet
+
+
+def main(argv=None) -> int:
+    parser = argparse.ArgumentParser(prog="myadder")
+    sub = parser.add_subparsers(dest="cmd", required=True)
+
+    p_add = sub.add_parser("add", help="Add two floats")
+    p_add.add_argument("a", type=float)
+    p_add.add_argument("b", type=float)
+
+    p_addi = sub.add_parser("add-int", help="Add two integers")
+    p_addi.add_argument("a", type=int)
+    p_addi.add_argument("b", type=int)
+
+    p_greet = sub.add_parser("greet", help="Greet someone")
+    p_greet.add_argument("name")
+
+    args = parser.parse_args(argv)
+
+    if args.cmd == "add":
+        add(args.a, args.b)
+    elif args.cmd == "add-int":
+        add_integers(args.a, args.b)
+    elif args.cmd == "greet":
+        greet(args.name)
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "conan-py-build"
-version = "0.4.1"
+version = "0.4.2"
 description = "A minimal PEP 517 compliant build backend that uses Conan to build Python C/C++ extensions"
 readme = "README.md"
 license = {text = "MIT"}

src/conan_py_build/build.py

@@ -304,6 +304,37 @@ def _write_metadata_file(dist_info_dir: Path, metadata: dict, project_dir: Path)
         f.write(content)
 
 
+def _write_entry_points(dist_info_dir: Path, metadata: dict, project_dir: Path) -> None:
+    """Write entry_points.txt per PEP 621 / PyPA entry-points spec; skip if empty."""
+    std = _get_standard_metadata(metadata, project_dir)
+    groups: dict = {}
+    if std.scripts:
+        groups["console_scripts"] = std.scripts
+    if std.gui_scripts:
+        groups["gui_scripts"] = std.gui_scripts
+    for group, entries in (std.entrypoints or {}).items():
+        if not entries:
+            continue
+        if group in groups:
+            raise RuntimeError(
+                f"Entry point group {group!r} declared in both "
+                "[project.entry-points] and [project.scripts]/[project.gui-scripts]."
+            )
+        groups[group] = entries
+    if not groups:
+        return
+
+    lines = []
+    for group, entries in groups.items():
+        lines.append(f"[{group}]")
+        for name, target in entries.items():
+            lines.append(f"{name} = {target}")
+        lines.append("")
+
+    with (dist_info_dir / "entry_points.txt").open("w", encoding="utf-8", newline="\n") as f:
+        f.write("\n".join(lines))
+
+
 def _create_dist_info(staging_dir: Path, metadata: dict, project_dir: Path) -> Path:
     """Create .dist-info directory with metadata files."""
     name = _normalize_name(metadata.get("name", "unknown"))
@@ -313,6 +344,7 @@ def _create_dist_info(staging_dir: Path, metadata: dict, project_dir: Path) -> P
     dist_info_dir.mkdir(parents=True, exist_ok=True)
 
     _write_metadata_file(dist_info_dir, metadata, project_dir)
+    _write_entry_points(dist_info_dir, metadata, project_dir)
 
     return dist_info_dir
 

tests/test_unit.py

@@ -20,6 +20,7 @@
     _check_wheel_package_path,
     _get_wheel_packages,
     _create_dist_info,
+    _write_entry_points,
     _build_wheel_with_tags,
     _copy_license_files_from_paths,
     _validate_version_config,
@@ -358,6 +359,56 @@ def test_prepare_metadata_dynamic_version_from_file(tmp_path, monkeypatch):
     assert "Version: 0.5.0" in (tmp_path / "meta" / name / "METADATA").read_text(encoding="utf-8")
 
 
+def test_write_entry_points_omits_file_when_no_entries(tmp_path):
+    dist_info = tmp_path / "pkg-1.0.0.dist-info"
+    dist_info.mkdir()
+    _write_entry_points(dist_info, {"name": "pkg", "version": "1.0.0"}, tmp_path)
+    assert not (dist_info / "entry_points.txt").exists()
+
+
+def test_write_entry_points_emits_all_section_kinds(tmp_path):
+    """scripts -> [console_scripts], gui-scripts -> [gui_scripts],
+    entry-points."group" -> [group], all coexisting in the same file."""
+    dist_info = tmp_path / "pkg-1.0.0.dist-info"
+    dist_info.mkdir()
+    metadata = {
+        "name": "pkg",
+        "version": "1.0.0",
+        "scripts": {"mytool": "pkg.cli:main"},
+        "gui-scripts": {"mygui": "pkg.gui:run"},
+        "entry-points": {"rasterio.rio_commands": {"info": "pkg.info:info"}},
+    }
+    _write_entry_points(dist_info, metadata, tmp_path)
+    content = (dist_info / "entry_points.txt").read_text(encoding="utf-8")
+    assert "[console_scripts]\nmytool = pkg.cli:main" in content
+    assert "[gui_scripts]\nmygui = pkg.gui:run" in content
+    assert "[rasterio.rio_commands]\ninfo = pkg.info:info" in content
+
+
+def test_write_entry_points_reserved_group_in_entry_points_raises(tmp_path):
+    """Reserved group ('console_scripts') under [project.entry-points] is forbidden by PEP 621."""
+    dist_info = tmp_path / "pkg-1.0.0.dist-info"
+    dist_info.mkdir()
+    metadata = {
+        "name": "pkg",
+        "version": "1.0.0",
+        "scripts": {"cli": "pkg.cli:main"},
+        "entry-points": {"console_scripts": {"other": "pkg.cli:other"}},
+    }
+    with pytest.raises(Exception):
+        _write_entry_points(dist_info, metadata, tmp_path)
+
+
+def test_create_dist_info_writes_entry_points_when_scripts_declared(tmp_path):
+    """End-to-end: _create_dist_info emits entry_points.txt alongside METADATA."""
+    staging = tmp_path / "staging"
+    staging.mkdir()
+    metadata = {"name": "pkg", "version": "1.0.0", "scripts": {"mytool": "pkg.cli:main"}}
+    dist_info = _create_dist_info(staging, metadata, tmp_path)
+    assert (dist_info / "METADATA").is_file()
+    assert (dist_info / "entry_points.txt").is_file()
+
+
 def test_prepare_metadata_with_license_file(tmp_path, monkeypatch):
     """License file declared in pyproject.toml is copied into .dist-info/licenses/."""
     (tmp_path / "pyproject.toml").write_text("""\