Add manpage and migrate to pyproject.toml

.github/workflows/deployment.yml

@@ -56,18 +56,14 @@ jobs:
         run: |
           . ./env/bin/activate
           pip install tox==${{ env.TOX_VERSION }}
-      - name: Prevent 0.0.0 releases I
-        run: |
-          . ./env/bin/activate
-          tox -e version.py
-          cat px/version.py
-          ! grep '0.0.0' px/version.py
       - name: Run tox to create the dist wheel
         run: |
           . ./env/bin/activate
           tox
-      - name: Prevent 0.0.0 releases II
+      - name: Prevent 0.0.0 releases
         run: |
+          cat px/version.py
+          ! grep '0.0.0' px/version.py
           ls dist/
           ! ls dist/ | grep '0.0.0'
 

.github/workflows/macos-ci.yml

@@ -42,4 +42,4 @@ jobs:
           # The point is to run as little as possible on macOS because macOS runs are
           # slow and expensive, look for "multiplier" on this page:
           # https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions
-          tox -e version.py,installtest,pytest,package,test-package,test-wheel
+          tox -e installtest,pytest,package,test-package,test-wheel

README.rst

@@ -250,7 +250,7 @@ Development
 Prerequisites
 -------------
 
-* A Python 3.6+ version
+* A Python 3.9+ version
 * `tox`_
 
 Building and Running

devbin/ptop-in-docker.sh

@@ -3,7 +3,7 @@
 set -euo pipefail
 
 DOCKERFILE="
-FROM python:3.6-alpine
+FROM python:3.9-alpine
 
 RUN apk add sudo py3-tox shellcheck bash git unzip lsof gcc python3-dev procps acct musl-dev zip
 RUN echo 'root    ALL=(ALL:ALL) ALL' > /etc/sudoers

devbin/test_clone_and_build.py

@@ -5,9 +5,9 @@
 """
 
 import os
-import sys
 import shutil
 import subprocess
+import sys
 import tempfile
 
 # Copy everything to a temporary directory
@@ -38,9 +38,6 @@
 )
 
 # Build the clone
-print("Building sources using setup.py...")
-subprocess.run(["python3", "setup.py", "build"], check=True)
-
 print("Building sources using python -m build...")
 FAKE_VERSION = "99.99.99"
 subprocess.run(["git", "config", "user.email", "you@example.com"], check=True)

devbin/tox-in-docker.sh

@@ -3,7 +3,7 @@
 set -euo pipefail
 
 DOCKERFILE="
-FROM python:3.6-alpine
+FROM python:3.9-alpine
 
 RUN apk add sudo py3-tox shellcheck bash git zip unzip lsof gcc python3-dev procps acct musl-dev
 RUN echo 'root    ALL=(ALL:ALL) ALL' > /etc/sudoers

px/px.py

@@ -139,9 +139,9 @@ def handleLogMessages(messages: Optional[str]) -> None:
     # even if we don't use it. And this will make test avoidance fail to avoid
     # px.py tests every time you make a new commit (because committing recreates
     # version.py).
-    from . import version
+    from .version import __version__
 
-    sys.stderr.write("px version: " + version.VERSION + "\n")
+    sys.stderr.write("px version: " + __version__ + "\n")
 
     sys.stderr.write("\n")
     sys.stderr.write("Python version: " + sys.version + "\n")
@@ -168,9 +168,9 @@ def _main(argv: List[str]) -> None:
         # NOTE: If we "import version" at the top of this file, we will depend on it even if
         # we don't use it. And this will make test avoidance fail to avoid px.py tests every
         # time you make a new commit (because committing recreates version.py).
-        from . import version
+        from .version import __version__
 
-        print(version.VERSION)
+        print(__version__)
         return
 
     with_pager: Optional[bool] = None

pyproject.toml

@@ -0,0 +1,57 @@
+[project]
+name = "pxpx"
+description = "ps and top for Human Beings"
+readme = "README.rst"
+license = "MIT"
+authors = [{ name = "Johan Walles", email = "johan.walles@gmail.com" }]
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: System Administrators",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Topic :: System :: Monitoring",
+    "Topic :: System :: Systems Administration",
+    "Topic :: Utilities",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/walles/px"
+
+[project.scripts]
+px = "px.px:main"
+ptop = "px.px:main"
+pxtree = "px.px:main"
+
+[tool.setuptools.data-files]
+"share/man/man1" = ["doc/*.1"]
+
+[tool.setuptools.packages.find]
+include = ["px*"]
+
+[tool.setuptools_scm]
+version_file = "px/version.py"
+fallback_version = "0.0.0+unknown"
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_any_unimported = true
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+strict_equality = true
+warn_incomplete_stub = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_ignores = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = ["-v"]
+
+[build-system]
+requires = ["setuptools>=77", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"