support for packages built with pyproject.toml

Author: edublancas

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## 0.8.3dev
 
+* [Feature] Add `pkgmt new NAME --use-pyproject-toml`
+
 ## 0.8.2 (2025-01-08)
 
 * [Fix] Compatibility with `mistune>=3.1.0`

src/pkgmt/assets/template/pyproject-setup.toml

@@ -0,0 +1,71 @@
+[tool.pytest.ini_options]
+addopts = "--pdbcls=IPython.terminal.debugger:Pdb"
+
+[tool.nbqa.addopts]
+flake8 = [
+    # notebooks allow non-top imports
+    "--extend-ignore=E402",
+    # jupysql notebooks might have "undefined name" errors
+    # due to the << operator
+    # W503, W504 ignore line break after/before
+    # binary operator since they are conflicting
+    "--ignore=F821, W503, W504",
+]
+
+[tool.pkgmt]
+# used to add links to issue numbers in CHANGELOG.md
+github = "ploomber/$project_name"
+# used to check that the package is importable when running pkgmt setup
+package_name = "$package_name"
+# defines the conda environment name when using pkgmt setup, if missing,
+# package_name is used
+env_name = "$project_name"
+
+[tool.pkgmt.check_links]
+extensions = ["md", "rst", "py", "ipynb"]
+
+
+# build settings
+# https://github.com/pypa/sampleproject/blob/main/pyproject.toml
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "$project_name"
+version = "0.0.1"
+description = "A sample Python project"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { file = "LICENSE.txt" }
+keywords = ["sample", "setuptools", "development"]
+authors = [{ name = "A. Random Developer", email = "[email protected]" }]
+maintainers = [
+    { name = "A. Great Maintainer", email = "[email protected]" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3 :: Only",
+]
+dependencies = []
+[project.optional-dependencies]
+dev = ["pytest", "flake8", "invoke", "twine"]
+
+[project.urls]
+"Homepage" = "https://github.com/pypa/sampleproject"
+"Bug Reports" = "https://github.com/pypa/sampleproject/issues"
+"Funding" = "https://donate.pypi.org"
+"Say Thanks!" = "http://saythanks.io/to/example"
+"Source" = "https://github.com/pypa/sampleproject/"
+
+[project.scripts]
+$project_name = "$package_name.cli:cli"
+
+[tool.setuptools]
+package-data = { "$package_name" = ["assets/*", "*.md"] }

src/pkgmt/assets/template/pyproject.toml

@@ -9,7 +9,7 @@ flake8 = [
     # due to the << operator
     # W503, W504 ignore line break after/before
     # binary operator since they are conflicting
-    "--ignore=F821, W503, W504"
+    "--ignore=F821, W503, W504",
 ]
 
 [tool.pkgmt]

src/pkgmt/cli.py

@@ -42,9 +42,15 @@ def check_links(only_404):
 
 @cli.command()
 @click.argument("name")
-def new(name):
+@click.option(
+    "--use-pyproject-toml",
+    is_flag=True,
+    default=False,
+    help="Use pyproject.toml instead of setup.py",
+)
+def new(name, use_pyproject_toml):
     """Create new package"""
-    new_.package(name)
+    new_.package(name, use_setup_py=not use_pyproject_toml)
 
 
 @cli.command()

src/pkgmt/new.py

@@ -12,7 +12,7 @@ def render_inplace(path, **kwargs):
     path.write_text(template.safe_substitute(**kwargs))
 
 
-def package(name):
+def package(name, use_setup_py=False):
     """Create a new package"""
     project_name = name.replace("_", "-")
     package_name = name.replace("-", "_")
@@ -32,6 +32,7 @@ def package(name):
         "tasks.py",
         "MANIFEST.in",
         "pyproject.toml",
+        "pyproject-setup.toml",
         ".github/workflows/ci.yml",
     ):
         render_inplace(
@@ -41,3 +42,12 @@ def package(name):
         )
 
     os.rename(root / "src" / "package_name", root / "src" / package_name)
+
+    if use_setup_py:
+        (root / "pyproject-setup.toml").unlink()
+    else:
+        (root / "pyproject.toml").unlink()
+        (root / "setup.py").unlink()
+        (root / "MANIFEST.in").unlink()
+        (root / "pyproject-setup.toml").rename(root / "pyproject.toml")
+        (root / "src" / package_name / "__init__.py").write_text("")

tests/test_new.py

@@ -11,20 +11,48 @@ def uninstall():
     subprocess.check_call(["pip", "uninstall", "somepkg", "-y"])
 
 
-def test_package(tmp_empty, uninstall):
-    new.package("some-cool_pkg")
+def test_package_setup_py(tmp_empty, uninstall):
+    new.package("some-cool_pkg", use_setup_py=True)
 
     subprocess.check_call(["pip", "install", "some-cool-pkg/"])
 
     pyproject = Path("some-cool-pkg", "pyproject.toml").read_text()
     setup = Path("some-cool-pkg", "setup.py").read_text()
     ci = Path("some-cool-pkg", ".github", "workflows", "ci.yml").read_text()
     manifest = Path("some-cool-pkg", "MANIFEST.in").read_text()
+    init = Path("some-cool-pkg", "src", "some_cool_pkg", "__init__.py").read_text()
 
+    assert '__version__ = "0.1dev"\n' == init
     assert 'github = "ploomber/some-cool-pkg"' in pyproject
     assert 'package_name = "some_cool_pkg"' in pyproject
     assert 'env_name = "some-cool-pkg"' in pyproject
     assert 'name="some-cool-pkg"' in setup
     assert "src/some_cool_pkg/__init__.py" in setup
     assert 'python -c "import some_cool_pkg"' in ci
     assert "graft src/some_cool_pkg/assets" in manifest
+
+
+def test_package_pyproject_toml(tmp_empty, uninstall):
+    new.package("some-cool_pkg", use_setup_py=False)
+
+    subprocess.check_call(["pip", "install", "some-cool-pkg/"])
+
+    pyproject = Path("some-cool-pkg", "pyproject.toml").read_text()
+    ci = Path("some-cool-pkg", ".github", "workflows", "ci.yml").read_text()
+    init = Path("some-cool-pkg", "src", "some_cool_pkg", "__init__.py").read_text()
+
+    assert not Path("some-cool-pkg", "setup.py").exists()
+    assert not Path("some-cool-pkg", "MANIFEST.in").exists()
+    assert not Path("some-cool-pkg", "pyproject-setup.toml").exists()
+
+    assert init == ""
+
+    assert 'github = "ploomber/some-cool-pkg"' in pyproject
+    assert 'package_name = "some_cool_pkg"' in pyproject
+    assert 'env_name = "some-cool-pkg"' in pyproject
+
+    # build settings
+    assert 'name = "some-cool-pkg"' in pyproject
+    assert 'package-data = { "some_cool_pkg" = ["assets/*", "*.md"] }' in pyproject
+
+    assert 'python -c "import some_cool_pkg"' in ci