⚡ 🐍 Change python default to pyproject.toml

The days of setuptools are numbered! Switch default component to use
pyproject.toml, it is currently the least deprecated way of building
python packages.

Also sneak in some nifty features like adding a `run` command for
clients and services. And add a corresponding entry point to their
package.

Also made the generated code pass `ruff`, it uses the
`--unsafe-fixes` to add period at the end of docstrings if missing.
Since it only runs on the templated code we know that it won't do
anything else.

CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Python now generates a `run` command and cli entry point for clients and services.
+
+### Changed
+- Python now uses `pyproject` instead of `setuptools` by default. Template for targetSetup
+  has been updated accordingly. It also conforms to `ruff`s checks and formatting by default.
+
 ### Fixed
 - Python's config merger now handles mypy overrides targeting multiple packages.
 

python/component-template/@mainPackage@/main.py

@@ -1,6 +1,6 @@
-""" @desc@ """
+"""@desc@"""
 
 
 def main() -> None:
-    """ main function of @mainPackage@ """
+    """Main function of @mainPackage@."""
     raise NotImplementedError

python/component-template/pyproject.toml

@@ -0,0 +1,18 @@
+[build-system]
+requires = ["setuptools"]
+
+[project]
+name = "@pname@"
+version = "@version@"
+description = "@desc@"
+authors = [{name = "@author@", email = "@email@"}]
+
+[setuptools.packages.find]
+exclude = ["tests*"]
+
+[urls]
+Homepage = "@email@"
+
+[project.scripts]
+@entryPoint@
+

python/component-template/tests/test_main.py

@@ -1,6 +1,7 @@
-""" Tests for @mainPackage@ in @pname@ """
+"""Tests for @mainPackage@ in @pname@."""
 import @mainPackage@.main
 
+
 def test_main() -> None:
-    """ Tests for the main function """
+    """Tests for the main function."""
     @mainPackage@.main.main()

python/main.py.in

@@ -0,0 +1,3 @@
+
+if __name__ == "__main__":
+    main()

python/package.nix

@@ -71,21 +71,26 @@ let
       inherit version;
       pname = name;
       mainPackage = lib.toLower (builtins.replaceStrings [ "-" " " ] [ "_" "_" ] name);
-      entryPoint = if setuptoolsLibrary then "{}" else "{\\\"console_scripts\\\": [\\\"${name}=${mainPackage}.main:main\\\"]}";
+      entryPoint = if setuptoolsLibrary then "" else "${name}=\\\"${mainPackage}.main:main\\\"";
     } // args.targetSetup.variables or { };
     variableQueries = {
       desc = "✍️ Write a short description for your component:";
       author = "🤓 Enter author name:";
       email = "📧 Enter author email:";
       url = "🏄 Enter author website url:";
     } // args.targetSetup.variableQueries or { };
-    initCommands = "black .";
+    initCommands = ''
+      ${if ! setuptoolsLibrary then "cat ${./main.py.in} >>$mainPackage/main.py" else ""}
+      ruff format .
+      ruff check --fix --unsafe-fixes .
+    '';
   });
 
   pythonPackageArgs = attrs // {
     inherit version preBuild doStandardTests pythonVersion propagatedBuildInputs;
     src = if lib.isStorePath src then src else filteredSrc;
     pname = name;
+    format = attrs.format or "pyproject";
 
     # Don't install dependencies with pip, let nix handle that
     preInstall = ''
@@ -170,7 +175,7 @@ let
           Show the config Nedryland has generated for a linter, one of:
           black, coverage, flake8, isort, mypy, pylint, pytest'';
       };
-    } // attrs.shellCommands or { });
+    } // (lib.optionalAttrs (! setuptoolsLibrary) { run = { script = ''python -m ${name}.main "$@"''; description = "Run the main module."; }; }) // attrs.shellCommands or { });
   };
 in
 pythonPkgs.buildPythonPackage pythonPackageArgs