package-dev-tools 0.6.0__tar.gz → 0.6.2__tar.gz

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: package-dev-tools
-Version: 0.6.0
+Version: 0.6.2
 Summary: CI/CD tools for Python packages
 Author-email: Quinten Roets <qdr2104@columbia.edu>
 License: MIT
@@ -11,7 +11,7 @@ License-File: LICENSE
 Requires-Dist: autotyping<25,>=23.3.0
 Requires-Dist: bump2version<2,>=1.0.1
 Requires-Dist: coverage<8,>=7.4.0
-Requires-Dist: mypy<2,>=1.10.0
+Requires-Dist: mypy<2,>=1.11.1
 Requires-Dist: package-utils<1,>=0.6.1
 Requires-Dist: pre-commit<4,>=3.5.0
 Requires-Dist: powercli<1,>=0.1.2

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "package-dev-tools"
-version = "0.6.0"
+version = "0.6.2"
 description = "CI/CD tools for Python packages"
 authors = [{name = "Quinten Roets", email = "qdr2104@columbia.edu"}]
 license = {text = "MIT"}
@@ -10,7 +10,7 @@ dependencies = [
     "autotyping >=23.3.0, <25",
     "bump2version >=1.0.1, <2",
     "coverage >=7.4.0, <8",
-    "mypy >=1.10.0, <2",
+    "mypy >=1.11.1, <2",
     "package-utils >=0.6.1, <1",
     "pre-commit >=3.5.0, <4",
     "powercli >=0.1.2, <1",
@@ -52,7 +52,7 @@ requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
 [tool.coverage.run]
-command_line = "-m pytest"
+command_line = "-m pytest tests"
 
 [tool.coverage.report]
 precision = 4
@@ -71,12 +71,12 @@ pythonpath = [
 fix = true
 
 [tool.ruff.lint]
-select = [
-    "E",  # pycodestyle errors
-    "W",  # pycodestyle warnings
-    "F",  # pyflakes
-    "I",  # isort
-    "UP",  # pyupgrade
+select = ["ALL"]
+ignore = [
+    "ANN101",  # annotate self
+    "ANN102",  # annotate cls
+    "ANN401",  # annotated with Any
+    "D", # docstrings
 ]
 
 [tool.ruff.lint.isort]
@@ -84,6 +84,7 @@ known-first-party = ["src"]
 
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401"]
+"tests/*" = ["S101"]  # assert used
 
 [tool.setuptools]
 script-files = [

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/actions/instantiate_new_project/cleanup_readme.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 
-from ...models import Path
+from package_dev_tools.models import Path
 
 
 @dataclass

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/actions/instantiate_new_project/cleanup_workflows.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 
-from ...models import Path
+from package_dev_tools.models import Path
 
 
 @dataclass

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/actions/instantiate_new_project/git.py

@@ -2,7 +2,7 @@ from dataclasses import dataclass, field
 
 import cli
 
-from ...models import Path
+from package_dev_tools.models import Path
 
 
 @dataclass
@@ -12,16 +12,19 @@ class GitInterface:
     git_email: str = "quinten.roets@gmail.com"
     commit_message: str = "Instantiate new project"
 
+    def clean(self) -> None:
+        self.capture_output("add -A")
+        self.capture_output("clean -fd")
+
     def commit(self) -> None:
-        self.get("add -A")
         self.configure()
-        self.get("commit --no-verify -m", self.commit_message)
+        self.capture_output("commit --no-verify -m", self.commit_message)
 
-    def get(self, *args: str | Path | int) -> str:
+    def capture_output(self, *args: str | Path | int) -> str:
         git_arg = f"git {args[0]}"
         return cli.capture_output(git_arg, *args[1:], cwd=self.path)
 
     def configure(self) -> None:
         git_configuration = {"name": self.git_name, "email": self.git_email}
         for attribute, value in git_configuration.items():
-            self.get(f"config user.{attribute} {value}")
+            self.capture_output(f"config user.{attribute} {value}")

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/actions/instantiate_new_project/instantiate_new_project.py

@@ -20,6 +20,9 @@ class ProjectInstantiator(NameSubstitutor):
             WorkflowsCleaner(self.path),
         )
         for runner in runners:
-            runner.run()  # type: ignore
+            runner.run()  # type: ignore[union-attr]
+
+        git = GitInterface(self.path)
+        git.clean()
         if self.commit:
-            GitInterface(self.path).commit()
+            git.commit()

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/actions/instantiate_new_project/substitute_template_name/project.py

@@ -2,7 +2,7 @@ from dataclasses import dataclass, field
 
 from slugify import slugify
 
-from ....models import Path
+from package_dev_tools.models import Path
 
 
 @dataclass

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/actions/instantiate_new_project/substitute_template_name/substitute_template_name.py

@@ -5,10 +5,10 @@ from dataclasses import dataclass, field
 import cli
 from slugify import slugify
 
+from package_dev_tools.actions.instantiate_new_project.git import GitInterface
+from package_dev_tools.models import Path
 from package_dev_tools.utils.package import PackageInfo
 
-from ....models import Path
-from ..git import GitInterface
 from .project import Project
 
 
@@ -44,7 +44,7 @@ class NameSubstitutor:
         }
 
     def extract_new_project_name(self) -> str:
-        git_url = GitInterface(self.path).get("config remote.origin.url")
+        git_url = GitInterface(self.path).capture_output("config remote.origin.url")
         return urllib.parse.urlparse(git_url).path.split("/")[-1]
 
     def extract_current_project_name(self) -> str:
@@ -57,9 +57,11 @@ class NameSubstitutor:
 
     def run(self) -> None:
         for path in self.generate_paths_to_substitute():
-            self.apply_substitutions(path)
+            if path.has_text_content:
+                self.substitute_content(path)
+            self.substitute_name(path)
 
-    def apply_substitutions(self, path: Path) -> None:
+    def substitute_content(self, path: Path) -> None:
         content = path.text
         if any(to_replace in content for to_replace in self.substitutions):
             for original, replacement in self.substitutions.items():
@@ -74,11 +76,9 @@ class NameSubstitutor:
             is_workflow = path.is_relative_to(workflows_folder)
             is_file = path.is_file()
             if not is_workflow and is_file:
-                if path.has_text_content:
-                    yield path
-                self.rename(path)
+                yield path
 
-    def rename(self, path: Path) -> None:
+    def substitute_name(self, path: Path) -> None:
         if any(name == self.template_project.package_name for name in path.parts):
             renamed_path_str = str(path).replace(
                 self.template_project.package_name,

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/actions/template_sync/sync_template.py

@@ -1,3 +1,4 @@
+import contextlib
 from collections.abc import Iterator
 from dataclasses import dataclass, field
 from functools import cached_property
@@ -9,16 +10,21 @@ from github.Repository import Repository
 from slugify import slugify
 from superpathlib import Path
 
-from ..instantiate_new_project import ProjectInstantiator
-from ..instantiate_new_project.git import GitInterface
-from ..instantiate_new_project.substitute_template_name import substitute_template_name
+from package_dev_tools.actions.instantiate_new_project import ProjectInstantiator
+from package_dev_tools.actions.instantiate_new_project.git import GitInterface
+from package_dev_tools.actions.instantiate_new_project.substitute_template_name import (
+    substitute_template_name,
+)
+
 from . import git
 
 
 @dataclass
 class TemplateSyncer(git.Client):  # pragma: nocover
     repository: str
-    ignore_patterns_path: Path = Path(".templatesyncignore")
+    ignore_patterns_path: Path = field(
+        default_factory=lambda: Path(".templatesyncignore"),
+    )
     template_repository: str = "quintenroets/python-package-template"
     only_latest_commit: bool = True
     default_branch: str = "main"
@@ -94,7 +100,10 @@ class TemplateSyncer(git.Client):  # pragma: nocover
         cli.run("git", "clone", url, path)
 
     def run_git(
-        self, *args: str | Path, input_: str | None = None, check: bool = True
+        self,
+        *args: str | Path,
+        input_: str | None = None,
+        check: bool = True,
     ) -> None:
         cwd = self.downloaded_repository_folder
         cli.run("git", *args, input=input_, cwd=cwd, check=check)
@@ -153,20 +162,22 @@ class TemplateSyncer(git.Client):  # pragma: nocover
     def apply_ignore_patterns(self) -> None:
         path = self.downloaded_repository_folder / self.ignore_patterns_path
         if path.exists():
-            for pattern in path.lines:
-                if pattern.endswith("/"):
-                    pattern = f"{pattern}*"
+            for line in path.lines:
+                pattern = f"{line}*" if line.endswith("/") else line
                 self.run_git("reset", pattern)
 
     def push_updates(self) -> None:
         self.run_git("push", "--set-upstream", "origin", self.update_branch)
         title = "Sync template changes"
-        try:
+        with contextlib.suppress(
+            github.GithubException,
+        ):  # Pull request already created
             self.repository_client.create_pull(
-                self.default_branch, self.update_branch, title=title, body=""
+                self.default_branch,
+                self.update_branch,
+                title=title,
+                body="",
             )
-        except github.GithubException:
-            pass  # Pull request already created
 
     @cached_property
     def repository_client(self) -> Repository:

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/cli/extract_package_name.py

@@ -1,3 +1,4 @@
+import cli
 from package_utils.cli import instantiate_from_cli_args
 
 from package_dev_tools.utils.package import PackageInfo
@@ -5,4 +6,4 @@ from package_dev_tools.utils.package import PackageInfo
 
 def entry_point() -> None:
     package_info = instantiate_from_cli_args(PackageInfo)
-    print(package_info.package_name)
+    cli.console.print(package_info.package_name)

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/cli/extract_required_python_version.py

@@ -1,3 +1,4 @@
+import cli
 from package_utils.cli import instantiate_from_cli_args
 
 from package_dev_tools.utils.package import PackageInfo
@@ -5,4 +6,4 @@ from package_dev_tools.utils.package import PackageInfo
 
 def entry_point() -> None:
     package_info = instantiate_from_cli_args(PackageInfo)
-    print(package_info.required_python_version)
+    cli.console.print(package_info.required_python_version)

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/cli/extract_supported_python_versions.py

@@ -1,5 +1,6 @@
 import json
 
+import cli
 from package_utils.cli import instantiate_from_cli_args
 
 from package_dev_tools.utils.package import PackageInfo
@@ -9,4 +10,4 @@ def entry_point() -> None:
     package_info = instantiate_from_cli_args(PackageInfo)
     versions = list(package_info.supported_python_versions)
     versions_json = json.dumps(versions)
-    print(versions_json)
+    cli.console.print(versions_json)

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/models/path.py

@@ -10,7 +10,7 @@ class Path(superpathlib.Path):
     @property
     def has_text_content(self) -> bool:
         try:
-            self.text
+            self.text  # noqa: B018
             has_text = True
         except UnicodeDecodeError:
             has_text = False

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/pre_commit/check_coverage.py

@@ -3,24 +3,24 @@ from collections.abc import Iterator
 
 import cli
 
-from ..models import Path
-from ..utils.badge import Badge, BadgeUpdater
+from package_dev_tools.models import Path
+from package_dev_tools.utils.badge import Badge, BadgeUpdater
 
 
-def check_coverage(verify_all_files_tested: bool = True) -> None:
+def check_coverage(*, verify_all_files_tested: bool = True) -> None:
     verify_coverage_results()
     if verify_all_files_tested:
         verify_all_python_files_tested()
 
     try:
         coverage_percentage = cli.capture_output("coverage report -i --format total")
-    except cli.CalledProcessError as exception:
+    except cli.CalledProcessError:
         cli.capture_output("coverage html -i", check=False)
         cli.run("coverage report -mi", check=False)
-        raise exception
+        raise
     coverage_percentage_has_changed = update_coverage_shield(coverage_percentage)
     if coverage_percentage_has_changed:
-        print(f"Updated test coverage: {coverage_percentage}%")
+        cli.console.print(f"Updated test coverage: {coverage_percentage}%")
         cli.capture_output("coverage html")
     exit_code = 1 if coverage_percentage_has_changed else 0
     sys.exit(exit_code)
@@ -37,7 +37,7 @@ def update_coverage_shield(coverage_percentage: float | str) -> bool:
 def verify_all_python_files_tested() -> None:
     python_files = set(generate_python_files())
     coverage_lines = cli.capture_output_lines("coverage report -i", check=False)
-    covered_files = set(line.split()[0] for line in coverage_lines[2:-2])
+    covered_files = {line.split()[0] for line in coverage_lines[2:-2]}
     not_covered_files = python_files - covered_files
     if not_covered_files:
         cli.run("coverage html -i", check=False)
@@ -46,7 +46,7 @@ def verify_all_python_files_tested() -> None:
             *not_covered_files,
         )
         message = "\n\t".join(message_parts)
-        raise Exception(message)
+        raise RuntimeError(message)
 
 
 def generate_python_files() -> Iterator[str]:
@@ -60,4 +60,5 @@ def generate_python_files() -> Iterator[str]:
 
 def verify_coverage_results() -> None:
     if not Path(".coverage").exists():
-        raise Exception("No coverage results found.")
+        message = "No coverage results found."
+        raise OSError(message)

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/utils/badge.py

@@ -2,7 +2,7 @@ from dataclasses import dataclass, field
 from functools import cached_property
 from typing import ClassVar
 
-from ..models import Path
+from package_dev_tools.models import Path
 
 
 @dataclass
@@ -31,7 +31,8 @@ class BadgeUpdater:
         path = self.cwd / Path.readme.name
         lines = path.lines
         if not self.contains_badge(lines):
-            raise Exception(f"README has no {self.badge.title} badge yet.")
+            message = f"README has no {self.badge.title} badge yet."
+            raise ValueError(message)
         has_changed = self.badge.line not in lines
         if has_changed:
             lines = (self.badge.line if self.is_badge(line) else line for line in lines)

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools/utils/package.py

@@ -7,6 +7,8 @@ import requests
 import toml
 from superpathlib import Path
 
+SUCCESS_CODE = 200
+
 
 @dataclass
 class PackageInfo:
@@ -52,7 +54,7 @@ class PackageInfo:
         base_url = "https://www.python.org/ftp/python/"
         filename = f"Python-{version}.tar.xz"
         url = f"{base_url}/{version}/{filename}"
-        return requests.head(url).status_code == 200
+        return requests.head(url, timeout=10).status_code == SUCCESS_CODE
 
     @property
     def pyproject_info(self) -> dict[str, Any]:

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: package-dev-tools
-Version: 0.6.0
+Version: 0.6.2
 Summary: CI/CD tools for Python packages
 Author-email: Quinten Roets <qdr2104@columbia.edu>
 License: MIT
@@ -11,7 +11,7 @@ License-File: LICENSE
 Requires-Dist: autotyping<25,>=23.3.0
 Requires-Dist: bump2version<2,>=1.0.1
 Requires-Dist: coverage<8,>=7.4.0
-Requires-Dist: mypy<2,>=1.10.0
+Requires-Dist: mypy<2,>=1.11.1
 Requires-Dist: package-utils<1,>=0.6.1
 Requires-Dist: pre-commit<4,>=3.5.0
 Requires-Dist: powercli<1,>=0.1.2

{package_dev_tools-0.6.0 → package_dev_tools-0.6.2}/src/package_dev_tools.egg-info/requires.txt

@@ -1,7 +1,7 @@
 autotyping<25,>=23.3.0
 bump2version<2,>=1.0.1
 coverage<8,>=7.4.0
-mypy<2,>=1.10.0
+mypy<2,>=1.11.1
 package-utils<1,>=0.6.1
 pre-commit<4,>=3.5.0
 powercli<1,>=0.1.2