pyprojkit 0.1.0__tar.gz → 0.2.0__tar.gz

{pyprojkit-0.1.0 → pyprojkit-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyprojkit
-Version: 0.1.0
+Version: 0.2.0
 Summary: Development workflow toolkit for Python projects: pyproject.toml sync, doit tasks, nox sessions
 Author: mm21
 Author-email: mm21 <mm21.dev@gmail.com>
@@ -277,6 +277,7 @@ All tasks share the same layout:
 - `__cache__/`: caches (doit db, pytest cache, coverage data, nox envs)
 - `__out__/`: generated artifacts (`test/` coverage + JUnit results, `doc/html`, `analysis/`, `uv/` build artifacts)
 - `badges/`: generated badge SVGs
+- `src/<package>`: package sources consumed by the `init` and `analysis` tasks; the containing directory is configurable via `ProjectConfig.packages_dir` (default `"src"`)
 
 ## Custom profiles
 

{pyprojkit-0.1.0 → pyprojkit-0.2.0}/README.md

@@ -234,6 +234,7 @@ All tasks share the same layout:
 - `__cache__/`: caches (doit db, pytest cache, coverage data, nox envs)
 - `__out__/`: generated artifacts (`test/` coverage + JUnit results, `doc/html`, `analysis/`, `uv/` build artifacts)
 - `badges/`: generated badge SVGs
+- `src/<package>`: package sources consumed by the `init` and `analysis` tasks; the containing directory is configurable via `ProjectConfig.packages_dir` (default `"src"`)
 
 ## Custom profiles
 

{pyprojkit-0.1.0 → pyprojkit-0.2.0}/pyproject.toml

@@ -27,7 +27,7 @@ license-files = ["LICENSE"]
 name = "pyprojkit"
 readme = "README.md"
 requires-python = ">=3.12,<3.15"  # managed by pyprojkit
-version = "0.1.0"
+version = "0.2.0"
 
 [project.optional-dependencies]
 all = [

{pyprojkit-0.1.0 → pyprojkit-0.2.0}/src/pyprojkit/config/project.py

@@ -5,6 +5,7 @@ Project-wide configuration, declared in a project's `pyprojconf.py`.
 from __future__ import annotations
 
 from dataclasses import dataclass, field
+from pathlib import Path
 from typing import Any, Sequence
 
 from .. import _paths
@@ -81,6 +82,7 @@ class MkinitConfig:
     Arguments passed to mkinit.
     """
 
+
 @dataclass(kw_only=True)
 class SphinxConfig:
     """
@@ -98,6 +100,7 @@ class SphinxConfig:
     built documentation when the doc task is run with `--copy`.
     """
 
+
 @dataclass(kw_only=True)
 class DocConfig:
     """
@@ -114,11 +117,13 @@ class DocConfig:
     Enables the `doc` task; opt-in.
     """
 
+
 @dataclass(kw_only=True)
 class AnalysisConfig:
     """
     Static analysis configuration.
     """
+
     mypy: MypyConfig | None = field(default_factory=MypyConfig)
     pyright: bool = True
 
@@ -128,11 +133,14 @@ class PublishConfig:
     """
     Configuration for building and publishing via uv.
     """
+
     out_dir: str = str(_paths.UV_PATH)
     """
     Directory for build artifacts; cleaned before each build so stale artifacts are
     never published.
     """
+
+
 @dataclass(kw_only=True)
 class ToolsConfig:
     """
@@ -142,6 +150,7 @@ class ToolsConfig:
     `pyprojkit.config.profiles`. The default instance corresponds to the default
     profile.
     """
+
     formatting: FormattingConfig = field(default_factory=FormattingConfig.default)
     test: TestConfig | None = field(default_factory=TestConfig)
     doit: DoitConfig = field(default_factory=DoitConfig)
@@ -157,6 +166,7 @@ class ToolsConfig:
 
     A key not otherwise managed creates a new managed table.
     """
+
     @classmethod
     def default(cls) -> ToolsConfig:
         """
@@ -174,6 +184,7 @@ class ProjectConfig:
 
     A project's `pyprojconf.py` must define a module-level instance named `config`.
     """
+
     package: str
     """
     Import name of the package, e.g. `"trilium_alchemy"`.
@@ -182,13 +193,23 @@ class ProjectConfig:
     """
     Supported Python versions.
     """
+    packages_dir: str = "src"
+    """
+    Directory containing packages, relative to the project root.
+    """
     format_paths: Sequence[str] = ("src", "test", "doc", "examples")
     """
     Directories to format (those which exist), in addition to `*.py` and `*.toml` files
     at the project root.
     """
-
     tools: ToolsConfig = field(default_factory=ToolsConfig.default)
     """
     Tool configurations.
     """
+
+    @property
+    def package_path(self) -> Path:
+        """
+        Path to the package directory, relative to the project root.
+        """
+        return Path(self.packages_dir) / self.package

{pyprojkit-0.1.0 → pyprojkit-0.2.0}/src/pyprojkit/tasks.py

@@ -22,6 +22,7 @@ from __future__ import annotations
 
 import os
 import shutil
+import xml.etree.ElementTree as ET
 from pathlib import Path
 from typing import Callable
 
@@ -40,7 +41,22 @@ __all__ = [
     "TaskFactory",
 ]
 
-TaskCreator = Callable[..., Task]
+type TaskCreator = Callable[..., Task]
+
+
+def _normalize_svg(path: Path | str):
+    """
+    Rewrite SVG with attributes sorted, as genbadge doesn't order them
+    deterministically.
+    """
+    ET.register_namespace("", "http://www.w3.org/2000/svg")
+    ET.register_namespace("xlink", "http://www.w3.org/1999/xlink")
+    tree = ET.parse(path)
+    for elem in tree.iter():
+        attrib = sorted(elem.attrib.items())
+        elem.attrib.clear()
+        elem.attrib.update(attrib)
+    tree.write(path, encoding="unicode")
 
 
 class TaskFactory:
@@ -172,6 +188,8 @@ class TaskFactory:
                     (create_folder, [_paths.BADGES_PATH]),
                     (run, (tests_args,)),
                     (run, (cov_args,)),
+                    (_normalize_svg, [_paths.PYTEST_BADGE_PATH]),
+                    (_normalize_svg, [_paths.COV_BADGE_PATH]),
                 ],
                 targets=[
                     str(_paths.PYTEST_BADGE_PATH),
@@ -218,13 +236,13 @@ class TaskFactory:
         Create `init` task which generates `__init__.py` files using mkinit.
         """
         mkinit = self._require(self._config.tools.doc.mkinit, "tools.doc.mkinit")
-        package = self._config.package
+        package_path = self._config.package_path
 
         def task_init() -> Task:
             return Task(
                 "init",
                 actions=[
-                    (run, (["mkinit", f"src/{package}", *mkinit.args],)),
+                    (run, (["mkinit", str(package_path), *mkinit.args],)),
                 ],
                 targets=[],
                 file_dep=[],
@@ -306,7 +324,7 @@ class TaskFactory:
         Create `analysis` task which runs static analysis tools.
         """
         analysis = self._require(self._config.tools.analysis, "tools.analysis")
-        package = self._config.package
+        package_path = self._config.package_path
 
         def task_analysis() -> Task:
             actions = []
@@ -322,14 +340,14 @@ class TaskFactory:
                                 str(_paths.MYPY_HTML_PATH),
                                 "--cobertura-xml-report",
                                 str(_paths.MYPY_XML_PATH),
-                                package,
+                                str(package_path),
                             ],
                         ),
                     )
                 )
 
             if analysis.pyright:
-                actions.append((run, (["pyright", package],)))
+                actions.append((run, (["pyright", str(package_path)],)))
 
             return Task(
                 "analysis",

{pyprojkit-0.1.0 → pyprojkit-0.2.0}/src/pyprojkit/versions.py

@@ -24,6 +24,7 @@ Updated along with pyprojkit releases; individual projects can override via
 `PythonVersions.patch_overrides`.
 """
 
+
 @dataclass(frozen=True)
 class PythonVersions:
     """

{pyprojkit-0.1.0 → pyprojkit-0.2.0}/src/pyprojkit/config/profiles.py

@@ -39,8 +39,8 @@ def _default_formatting() -> FormattingConfig:
         formatters=(
             AutoflakeConfig(),
             IsortConfig(),
-            BlackConfig(),
             DocformatterConfig(),
+            BlackConfig(),
             TomlSortConfig(),
         )
     )