Use pipx for cli scripts and hatch for hatch version (#389)

Author: blink1073

jupyter_releaser/cli.py

@@ -283,7 +283,7 @@ def main(force):
     click.option(
         "--pydist-check-cmd",
         envvar="RH_PYDIST_CHECK_CMD",
-        default="twine check --strict",
+        default="pipx run twine check --strict",
         help="The command to use to check a python distribution file",
     ),
     click.option(
@@ -666,7 +666,7 @@ def extract_release(
     "--twine-cmd",
     help="The twine to run for Python release",
     envvar="TWINE_COMMAND",
-    default="twine upload",
+    default="pipx run twine upload",
 )
 @click.option(
     "--npm-registry",

jupyter_releaser/lib.py

@@ -488,7 +488,7 @@ def publish_assets(
         # in a temporary directory
         if len(glob(f"{dist_dir}/*.whl")):
             python.start_local_pypi()
-            twine_cmd = "twine upload --repository-url=http://0.0.0.0:8081"
+            twine_cmd = "pipx run twine upload --repository-url=http://0.0.0.0:8081"
             os.environ["TWINE_USERNAME"] = "foo"
             twine_token = twine_token or "bar"
         npm_cmd = "npm publish --dry-run"

jupyter_releaser/python.py

@@ -26,7 +26,7 @@ def build_dist(dist_dir, clean=True):
             os.remove(pkg)
 
     if PYPROJECT.exists():
-        util.run(f"python -m build --outdir {dest} .", quiet=True, show_cwd=True)
+        util.run(f"pipx run build --outdir {dest} .", quiet=True, show_cwd=True)
     elif SETUP_PY.exists():
         util.run(f"python setup.py sdist --dist-dir {dest}", quiet=True)
         util.run(f"python setup.py bdist_wheel --dist-dir {dest}", quiet=True)
@@ -36,7 +36,7 @@ def check_dist(
     dist_file,
     test_cmd="",
     python_imports=None,
-    check_cmd="twine check --strict",
+    check_cmd="pipx twine check --strict",
     resource_paths=None,
 ):
     """Check a Python package locally (not as a cli)"""

jupyter_releaser/tests/conftest.py

@@ -128,7 +128,7 @@ def py_dist(py_package, runner, mocker, build_mock, git_prep):
     changelog_entry = testutil.mock_changelog_entry(py_package, runner, mocker)
 
     # Create the dist files
-    util.run("python -m build .", cwd=util.CHECKOUT_NAME, quiet=True)
+    util.run("pipx run build .", cwd=util.CHECKOUT_NAME, quiet=True)
 
     # Finalize the release
     runner(["tag-release"])
@@ -177,7 +177,7 @@ def build_mock(mocker):
     orig_run = util.run
 
     def wrapped(cmd, **kwargs):
-        if cmd == "python -m build .":
+        if cmd == "pipx run build .":
             if osp.exists(util.CHECKOUT_NAME):
                 dist_dir = Path(f"{util.CHECKOUT_NAME}/dist")
             else:

jupyter_releaser/tests/test_cli.py

@@ -487,7 +487,7 @@ def test_tag_release(py_package, runner, build_mock, git_prep):
     # Bump the version
     runner(["bump-version", "--version-spec", VERSION_SPEC])
     # Create the dist files
-    util.run("python -m build .", cwd=util.CHECKOUT_NAME)
+    util.run("pipx run build .", cwd=util.CHECKOUT_NAME)
     # Tag the release
     runner(
         [
@@ -554,7 +554,7 @@ def test_extract_dist_py(py_package, runner, mocker, mock_github, tmp_path, git_
     changelog_entry = mock_changelog_entry(py_package, runner, mocker)
 
     # Create the dist files
-    run("python -m build .", cwd=util.CHECKOUT_NAME)
+    run("pipx run build .", cwd=util.CHECKOUT_NAME)
 
     # Finalize the release
     runner(["tag-release"])
@@ -588,7 +588,7 @@ def test_extract_dist_multipy(py_multipackage, runner, mocker, mock_github, tmp_
     dist_dir = normalize_path(Path(util.CHECKOUT_NAME).resolve() / "dist")
     for package in py_multipackage:
         run(
-            f"python -m build . -o {dist_dir}",
+            f"pipx run build . -o {dist_dir}",
             cwd=Path(util.CHECKOUT_NAME) / package["rel_path"],
         )
         files.extend(glob(dist_dir + "/*.*"))
@@ -638,7 +638,7 @@ def test_extract_dist_npm(npm_dist, runner, mocker, mock_github, tmp_path):
 def test_publish_assets_py(py_package, runner, mocker, git_prep, mock_github):
     # Create the dist files
     changelog_entry = mock_changelog_entry(py_package, runner, mocker)
-    run("python -m build .", cwd=util.CHECKOUT_NAME)
+    run("pipx run build .", cwd=util.CHECKOUT_NAME)
 
     orig_run = util.run
     called = 0
@@ -647,7 +647,7 @@ def test_publish_assets_py(py_package, runner, mocker, git_prep, mock_github):
 
     def wrapped(cmd, **kwargs):
         nonlocal called
-        if cmd.startswith("twine upload"):
+        if "twine upload" in cmd:
             if kwargs["env"]["TWINE_PASSWORD"] == "foo-token":
                 called += 1
         return orig_run(cmd, **kwargs)
@@ -763,7 +763,7 @@ def test_config_file(py_package, runner, mocker, git_prep):
 
     def wrapped(cmd, **kwargs):
         nonlocal called
-        if cmd.startswith("python -m build --outdir foo"):
+        if cmd.startswith("pipx run build --outdir foo"):
             called = True
             return ""
         return orig_run(cmd, **kwargs)
@@ -785,7 +785,7 @@ def test_config_file_env_override(py_package, runner, mocker, git_prep):
 
     def wrapped(cmd, **kwargs):
         nonlocal called
-        if cmd.startswith("python -m build --outdir bar"):
+        if cmd.startswith("pipx run build --outdir bar"):
             called = True
             return ""
         return orig_run(cmd, **kwargs)
@@ -807,7 +807,7 @@ def test_config_file_cli_override(py_package, runner, mocker, git_prep):
 
     def wrapped(cmd, **kwargs):
         nonlocal called
-        if cmd.startswith("python -m build --outdir bar"):
+        if cmd.startswith("pipx run build --outdir bar"):
             called = True
             return ""
         return orig_run(cmd, **kwargs)

jupyter_releaser/tests/test_functions.py

@@ -237,7 +237,7 @@ def test_compute_sha256(py_package):
 def test_create_release_commit(py_package, build_mock):
     util.bump_version("0.0.2a0")
     version = util.get_version()
-    util.run("python -m build .")
+    util.run("pipx run build .")
     shas = util.create_release_commit(version)
     assert util.normalize_path("dist/foo-0.0.2a0.tar.gz") in shas
     assert util.normalize_path("dist/foo-0.0.2a0-py3-none-any.whl") in shas
@@ -257,7 +257,7 @@ def test_create_release_commit_hybrid(py_package, build_mock):
     txt += testutil.TBUMP_NPM_TEMPLATE
     (py_package / "tbump.toml").write_text(txt, encoding="utf-8")
 
-    util.run("python -m build .")
+    util.run("pipx run build .")
     shas = util.create_release_commit(version)
     assert len(shas) == 2
     assert util.normalize_path("dist/foo-0.0.2a0.tar.gz") in shas

jupyter_releaser/util.py

@@ -42,7 +42,7 @@
 METADATA_JSON = Path("metadata.json")
 
 BUF_SIZE = 65536
-TBUMP_CMD = "tbump --non-interactive --only-patch"
+TBUMP_CMD = "pipx run tbump --non-interactive --only-patch"
 
 CHECKOUT_NAME = ".jupyter_releaser_checkout"
 
@@ -166,10 +166,10 @@ def get_version():
         if version:
             return version
 
-        # If this is a hatchling project, use hatchling to get
+        # If this is a hatchling project, use hatch to get
         # the dynamic version.
         if data.get("build-system", {}).get("build-backend") == "hatchling.build":
-            return run("hatchling version").split("\n")[-1]
+            return run("pipx run hatch version").split("\n")[-1]
 
     if SETUP_PY.exists():
         warnings.warn("Using deprecated setup.py invocation")
@@ -181,7 +181,7 @@ def get_version():
     # Build the wheel and extract the version.
     if PYPROJECT.exists():
         with tempfile.TemporaryDirectory() as tempdir:
-            run(f"{sys.executable} -m build --wheel --outdir {tempdir}")
+            run(f"pipx run build --wheel --outdir {tempdir}")
             wheel_path = glob(f"{tempdir}/*.whl")[0]
             wheel = Wheel(wheel_path)
             version = wheel.version
@@ -252,7 +252,7 @@ def bump_version(version_spec, *, changelog_path="", version_cmd=""):
             if "tool.tbump" in pyproject_text:
                 version_cmd = version_cmd or TBUMP_CMD
             elif "hatchling.build" in pyproject_text:
-                version_cmd = version_cmd or "hatchling version"
+                version_cmd = version_cmd or "pipx run hatch version"
 
         if SETUP_CFG.exists():
             if "bumpversion" in SETUP_CFG.read_text(encoding="utf-8"):
@@ -266,13 +266,13 @@ def bump_version(version_spec, *, changelog_path="", version_cmd=""):
 
     # Assign default values if no version spec was given
     if not version_spec:
-        if "tbump" in version_cmd or "hatchling" in version_cmd:
+        if "tbump" in version_cmd or "hatch" in version_cmd:
             version_spec = "next"
         else:
             version_spec = "patch"
 
     # Add some convenience options on top of "tbump" and "hatch"
-    if "tbump" in version_cmd or "hatchling" in version_cmd:
+    if "tbump" in version_cmd or "hatch" in version_cmd:
         v = parse_version(get_version())
         assert isinstance(v, Version)
 

pyproject.toml

@@ -22,24 +22,19 @@ urls = {Homepage = "https://jupyter.org"}
 requires-python = ">=3.8"
 dynamic = ["version"]
 dependencies = [
-    "build",
-    "check-manifest",
     "click",
     "ghapi",
     "github-activity~=0.2",
-    "hatchling>=1.0",
     "importlib_resources",
     "jsonschema>=3.0.1",
     "packaging",
     "pkginfo",
-    "pre-commit",
-    "pypiserver",
     "pytest-check-links>=0.7",
+    "pypiserver",
+    "pipx",
     "requests",
     "requests_cache",
-    "tbump~=6.7",
     "toml~=0.10",
-    "twine",
 ]
 
 [project.readme]
@@ -50,6 +45,7 @@ content-type = "text/markdown"
 test = [
     "coverage",
     "fastapi",
+    "pre-commit",
     "pytest>=7.0",
     "pytest-cov",
     "pytest-mock",