package-dev-tools 0.1.1__py3-none-any.whl

package_dev_tools/actions/cleanup_readme.py

@@ -0,0 +1,10 @@
+from ..models import Path
+
+
+def cleanup_readme() -> None:
+    path = Path.readme
+    delimiter = "=" * 60 + "\n"
+    keyword = "## Usage"
+    text_parts = path.text.split(delimiter)
+    text_parts[0] = text_parts[0].split(keyword)[0]
+    path.text = keyword.join(text_parts)

package_dev_tools/actions/substitute_template_name.py

@@ -0,0 +1,114 @@
+from __future__ import annotations
+
+from collections.abc import Iterator
+from dataclasses import dataclass
+
+import cli
+from plib import Path
+from slugify import slugify
+
+from package_dev_tools.utils.package import extract_package_name, extract_package_slug
+
+
+@dataclass
+class Project:
+    package_slug: str
+    path: Path = Path.cwd()
+
+    def __post_init__(self) -> None:
+        self.check_package_slug()
+        self.package_name = slugify(self.package_slug, separator="_")
+        self.name = slugify(self.package_slug, separator=" ").title()
+
+    def check_package_slug(self) -> None:
+        is_valid = self.package_slug == slugify(self.package_slug) and self.package_slug
+        if not is_valid:
+            self.raise_invalid_naming_exception()
+
+    def raise_invalid_naming_exception(self) -> None:
+        suggested_name = slugify(self.package_slug)
+        message = (
+            f"The project name '{self.package_slug}' is invalid.\n"
+            f"Suggested name: {suggested_name}"
+        )
+        raise ValueError(message)
+
+
+@dataclass
+class NameSubstitutor:
+    project_name: str
+    path: Path
+    current_project_name: str = ""
+    custom_template_package_name: str = "python-package-qtemplate"
+
+    def __post_init__(self) -> None:
+        self.new_project = Project(self.project_name, self.path)
+        if not self.current_project_name:
+            self.current_project_name = self.extract_current_project_name()
+        self.template_project = Project(self.current_project_name, self.path)
+        self.substitutions = {
+            self.custom_template_package_name: self.template_project.package_slug,
+            self.template_project.name: self.new_project.name,
+            self.template_project.package_slug: self.new_project.package_slug,
+            self.template_project.package_name: self.new_project.package_name,
+        }
+
+    def extract_current_project_name(self) -> str:
+        package_slug = extract_package_slug(self.path)
+        if package_slug == self.custom_template_package_name:
+            package_name = extract_package_name(self.path)
+            package_slug = slugify(package_name, separator="-")
+        return package_slug
+
+    def run(self) -> None:
+        for path in self.generate_paths_to_substitute():
+            self.apply_substitutions(path)
+
+    def apply_substitutions(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():
+                content = content.replace(original, replacement)
+            path.text = content
+
+    def generate_paths_to_substitute(self) -> Iterator[Path]:
+        workflows_folder = self.path / ".github" / "workflows"
+        for path in self.generate_project_files():
+            # Modifying workflow files requires additional permissions.
+            # Therefore, we don't do substitute those
+            is_workflow = path.is_relative_to(workflows_folder)
+            is_file = path.is_file()
+            if not is_workflow and is_file:
+                try:
+                    path.text
+                    has_text = True
+                except UnicodeDecodeError:
+                    has_text = False
+                if has_text:
+                    yield path
+                self.rename(path)
+
+    def rename(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,
+                self.new_project.package_name,
+            )
+            renamed_path = Path(renamed_path_str)
+            path.rename(renamed_path)
+
+    def generate_project_files(self) -> Iterator[Path]:
+        command = ("git", "ls-tree", "-r", "HEAD", "--name-only")
+        relative_paths = cli.lines(command, cwd=self.path)
+        for path in relative_paths:
+            yield self.path / path
+
+
+def substitute_template_name(
+    project_name: str = "",
+    path_str: str = "",
+    current_project_name: str = "",
+) -> None:
+    # TODO: use create instance from cli args from package-utils
+    path = Path(path_str) if path_str else Path.cwd()
+    NameSubstitutor(project_name, path, current_project_name=current_project_name).run()

package_dev_tools/actions/trigger_template_sync.py

@@ -0,0 +1,36 @@
+from concurrent.futures import ThreadPoolExecutor
+from dataclasses import dataclass
+
+import github.Auth
+from github import Github, UnknownObjectException
+from github.Repository import Repository
+
+
+@dataclass
+class TemplateSyncTriggerer:
+    token: str
+    workflow_name: str = "sync-template.yml"
+    max_workers: int = 10
+
+    def __post_init__(self) -> None:
+        auth = github.Auth.Token(self.token)
+        self.client = Github(auth=auth)
+
+    def run(self) -> None:
+        paginated_repos = self.client.get_user().get_repos(type="owner")
+        repos = list(paginated_repos)
+        with ThreadPoolExecutor(max_workers=self.max_workers) as executor:
+            executor.map(self.trigger_if_possible, repos)
+
+    def trigger_if_possible(self, repo: Repository) -> None:
+        try:
+            workflow = repo.get_workflow(self.workflow_name)
+        except UnknownObjectException:
+            workflow = None
+
+        if workflow is not None:
+            workflow.create_dispatch("main")
+
+
+def trigger_template_sync(token: str) -> None:
+    TemplateSyncTriggerer(token).run()

package_dev_tools/interfaces/cli/check_coverage.py

@@ -0,0 +1,7 @@
+import typer
+
+from package_dev_tools.pre_commit.check_coverage import check_coverage
+
+
+def entry_point() -> None:
+    typer.run(check_coverage)

package_dev_tools/interfaces/cli/cleanup_readme.py

@@ -0,0 +1,7 @@
+import typer
+
+from package_dev_tools.actions.cleanup_readme import cleanup_readme
+
+
+def entry_point() -> None:
+    typer.run(cleanup_readme)

package_dev_tools/interfaces/cli/substitute_template_name.py

@@ -0,0 +1,7 @@
+import typer
+
+from package_dev_tools.actions.substitute_template_name import substitute_template_name
+
+
+def entry_point() -> None:
+    typer.run(substitute_template_name)

package_dev_tools/interfaces/cli/trigger_template_sync.py

@@ -0,0 +1,7 @@
+import typer
+
+from package_dev_tools.actions.trigger_template_sync import trigger_template_sync
+
+
+def entry_point() -> None:
+    typer.run(trigger_template_sync)

package_dev_tools/models/__init__.py

@@ -0,0 +1 @@
+from .path import Path

package_dev_tools/models/path.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from typing import TypeVar
+
+import plib
+from simple_classproperty import classproperty
+
+T = TypeVar("T", bound="Path")
+
+
+class Path(plib.Path):  # type: ignore # TODO: remove after superpathlib fix
+    @classproperty
+    def readme(cls: type[T]) -> T:  # type: ignore
+        return cls("README.md")

package_dev_tools/pre_commit/check_coverage.py

@@ -0,0 +1,85 @@
+import sys
+import typing
+from collections.abc import Iterator
+
+import cli
+
+from package_dev_tools.utils.package import extract_package_slug
+
+from ..models import Path
+
+
+def check_coverage(verify_all_files_tested: bool = True) -> None:
+    generate_coverage_results()
+    if verify_all_files_tested:
+        verify_all_python_files_tested()
+
+    coverage_percentage = cli.get("coverage report --format total")
+    coverage_percentage = typing.cast(str, coverage_percentage)
+    coverage_percentage_has_changed = update_coverage_shield(coverage_percentage)
+    if coverage_percentage_has_changed:
+        print(f"Updated test coverage: {coverage_percentage}%")
+        cli.get("coverage html")
+    exit_code = 1 if coverage_percentage_has_changed else 0
+    sys.exit(exit_code)
+
+
+def update_coverage_shield(coverage_percentage: float | str) -> bool:
+    if isinstance(coverage_percentage, str):
+        coverage_percentage = float(coverage_percentage)
+    coverage_percentage_int = round(coverage_percentage)
+    markdown_line_start = "![Coverage]("
+    badge_url_root = "https://img.shields.io/badge"
+    badge_url = f"{badge_url_root}/Coverage-{coverage_percentage_int }%25-brightgreen"
+    markdown_line = f"{markdown_line_start}{badge_url})"
+    current_markdown_lines = Path.readme.lines
+    no_badge = not any(markdown_line_start in line for line in current_markdown_lines)
+    if no_badge:
+        raise Exception("README has no coverage badge yet.")
+    converage_percentage_has_changed = markdown_line not in current_markdown_lines
+    lines = (
+        markdown_line if line.startswith(markdown_line_start) else line
+        for line in current_markdown_lines
+    )
+    lines_with_empty_lines = *lines, ""
+    Path.readme.text = "\n".join(lines_with_empty_lines)
+    return converage_percentage_has_changed
+
+
+def verify_all_python_files_tested() -> None:
+    python_files = set(generate_python_files())
+    coverage_lines = cli.lines("coverage report")
+    covered_files = set(line.split()[0] for line in coverage_lines[2:-2])
+    not_covered_files = python_files - covered_files
+    if not_covered_files:
+        message_parts = (
+            "The following files are not covered by tests:",
+            *not_covered_files,
+        )
+        message = "\n\t".join(message_parts)
+        raise Exception(message)
+
+
+def generate_python_files() -> Iterator[str]:
+    project_folder = Path.cwd()
+    python_files = project_folder.rglob("*.py")
+    for path in python_files:
+        relative_path = path.relative_to(project_folder)
+        if relative_path.parts[0] != "build":
+            yield str(relative_path)
+
+
+def generate_coverage_results() -> None:
+    coverage_results_path = Path(".coverage")
+    package_slug = extract_package_slug()
+    try:
+        package_info = cli.get("pip show", package_slug)
+    except cli.CalledProcessError:
+        is_installed_non_editable = False
+    else:
+        is_installed_non_editable = "Editable project location: " not in package_info
+    if is_installed_non_editable:
+        cli.run("pip uninstall -y", package_slug)
+        coverage_results_path.unlink(missing_ok=True)
+    if not Path(".coverage").exists():
+        cli.run("coverage run")

package_dev_tools/py.typed

@@ -0,0 +1 @@
+ 

package_dev_tools/utils/package/__init__.py

@@ -0,0 +1 @@
+from .utils import extract_package_name, extract_package_slug

package_dev_tools/utils/package/utils.py

@@ -0,0 +1,23 @@
+import tomllib
+from typing import Any
+
+from plib import Path
+
+
+def extract_package_name(path: Path | None = None) -> str:
+    info = extract_pyproject_info(path)
+    package_data = info["tool"]["setuptools"]["package-data"]
+    project_name = next(iter(package_data))
+    return project_name
+
+
+def extract_package_slug(path: Path | None = None) -> str:
+    info = extract_pyproject_info(path)
+    return info["project"]["name"]
+
+
+def extract_pyproject_info(path: Path | None) -> dict[str, Any]:
+    if path is None:
+        path = Path.cwd()
+    info_path = path / "pyproject.toml"
+    return tomllib.loads(info_path.text)

package_dev_tools/utils/tests/__init__.py

@@ -0,0 +1 @@
+from .utils import clear_cli_args, set_cli_args

package_dev_tools/utils/tests/utils.py

@@ -0,0 +1,14 @@
+import sys
+from typing import Any
+
+from _pytest.monkeypatch import MonkeyPatch
+
+
+def clear_cli_args(monkeypatch: MonkeyPatch) -> None:
+    set_cli_args(monkeypatch)
+
+
+def set_cli_args(monkeypatch: MonkeyPatch, *args: Any) -> None:
+    str_args = (str(arg) for arg in args)
+    sys_args = ["test_create_instance", *str_args]
+    monkeypatch.setattr(sys, "argv", sys_args)

package_dev_tools-0.1.1.data/scripts/check-version

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+# don't bump/check bump in GitHub actions
+if [ "$(git branch --show-current)" = "main" ]; then
+    if [ "$GITHUB_ACTIONS" != "true" ]; then
+        if ! git diff --staged pyproject.toml | grep -q version; then
+            bump2version --config-file .bumpversion.cfg patch
+        fi
+    fi
+fi

package_dev_tools-0.1.1.data/scripts/cleanup-workflows

@@ -0,0 +1,4 @@
+#! /bin/env bash
+
+rm workflows/instantiate-package-dev-tools.yml
+rm workflows/trigger-template-sync.yml

package_dev_tools-0.1.1.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Quinten Roets
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package_dev_tools-0.1.1.dist-info/METADATA

@@ -0,0 +1,37 @@
+Metadata-Version: 2.1
+Name: package-dev-tools
+Version: 0.1.1
+Summary: Python package
+Author-email: Quinten Roets <qdr2104@columbia.edu>
+License: MIT
+Project-URL: Source Code, https://github.com/quintenroets/package-dev-tools
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pygithub >=2.1
+Requires-Dist: python-slugify >=8.0
+Requires-Dist: simple-classproperty >=4.0
+Requires-Dist: superpathlib >=1.3
+Requires-Dist: typer >=0.9
+Requires-Dist: quinten-cli >=1.1
+Provides-Extra: dev
+Requires-Dist: build ; extra == 'dev'
+Requires-Dist: bump2version ; extra == 'dev'
+Requires-Dist: coverage ; extra == 'dev'
+Requires-Dist: hypothesis ; extra == 'dev'
+Requires-Dist: pre-commit ; extra == 'dev'
+Requires-Dist: pytest ; extra == 'dev'
+Requires-Dist: pytest-mypy-plugins ; extra == 'dev'
+Requires-Dist: package-dev-tools ; extra == 'dev'
+
+# Package Dev Tools
+[![PyPI version](https://badge.fury.io/py/package-dev-tools.svg)](https://badge.fury.io/py/package-dev-tools)
+![Coverage](https://img.shields.io/badge/Coverage-100%25-brightgreen)
+## Usage
+* Use [actions](https://github.com/quintenroets/package-dev-tools/tree/main/actions) in .github/workflows
+* Use [pre-commit hooks](https://github.com/quintenroets/package-dev-tools/tree/main/.pre-commit-hooks.yaml) in .pre-commit-config.yaml
+## Installation
+```shell
+pip install package-dev-tools
+```
+make sure to use Python 3.10+

package_dev_tools-0.1.1.dist-info/RECORD

@@ -0,0 +1,29 @@
+package_dev_tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+package_dev_tools/py.typed,sha256=4W8VliAYUP1KY2gLJ_YDy2TmcXYVm-PY7XikQD_bFwA,2
+package_dev_tools/actions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+package_dev_tools/actions/cleanup_readme.py,sha256=zXQYuH2ozySGYG0zjzT-d-47njcYQCbC38Cqbkjf0FU,275
+package_dev_tools/actions/substitute_template_name.py,sha256=v1dXBkgeKOPMOUkUnrgUlzkR9j85YXiJm_jQIWP48yI,4312
+package_dev_tools/actions/trigger_template_sync.py,sha256=TWJvzc33sBBk26djwO3WgI3uopcHm3yIFHs0ziE1A4Y,1088
+package_dev_tools/interfaces/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+package_dev_tools/interfaces/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+package_dev_tools/interfaces/cli/check_coverage.py,sha256=FEW2owlotguGQQ3dNSMRdV7W4L464kZPFIl8rbln_to,144
+package_dev_tools/interfaces/cli/cleanup_readme.py,sha256=u4G9sOGbynNwKC-9TlNjMONiZEewxYfrluz8aORCFZc,141
+package_dev_tools/interfaces/cli/substitute_template_name.py,sha256=r3b1ApRg1--Vvw0C0DpDUO7Emuj5lKmuOzO8jyO2URw,171
+package_dev_tools/interfaces/cli/trigger_template_sync.py,sha256=m4qM9EcAVVOSlp0HiRIDL-uQp6N5wlJGlmSTOTyFtnE,162
+package_dev_tools/models/__init__.py,sha256=1OeLZ6FZ5gAjlerAjc69Vx0AqWLSx6OSqNCpuzkCZQg,23
+package_dev_tools/models/path.py,sha256=S5QYiFx18oYG0MYH75axKTtoH4_Fr72zna5GxQ9ljtw,336
+package_dev_tools/pre_commit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+package_dev_tools/pre_commit/check_coverage.py,sha256=0HBFRGzeSYQiG47uv5hFymLXl8UIEdDKKFjkrpBLWYE,3198
+package_dev_tools/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+package_dev_tools/utils/package/__init__.py,sha256=qDQe6KPiKE-5tUo57zVgTCIu3ej-4_LHmeDQWDMJGyc,62
+package_dev_tools/utils/package/utils.py,sha256=iMWZs4EtjfAQAhFE1vmdGugl-S9AC9v5GkX8_phOZF8,623
+package_dev_tools/utils/tests/__init__.py,sha256=2PBvBgS2em5pX-VCEhQ3LWJbQDiKl4a3FkpYi8nnp48,48
+package_dev_tools/utils/tests/utils.py,sha256=LExKTxz-cMxOGjW7UmVK5VWYmYnc0ZXd5f4suI5X10U,371
+package_dev_tools-0.1.1.data/scripts/check-version,sha256=Xwnoo_HQJAOqRlsL5CypDQQDa0iOm0MVDoezTLsUg0c,314
+package_dev_tools-0.1.1.data/scripts/cleanup-workflows,sha256=Sn81o-jvTK-r1RR2q-J9DCA8W7NxcQsG_ddjLMLvLrg,104
+package_dev_tools-0.1.1.dist-info/LICENSE,sha256=ENpNaBSvIV7ifD7iNz_-lBhImbiYowqPzBc5V5R8IhM,1070
+package_dev_tools-0.1.1.dist-info/METADATA,sha256=EhD9KtSSDfHv-A3M2R6DAXpS_GCXXYjzYDCkeAQc-oc,1425
+package_dev_tools-0.1.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+package_dev_tools-0.1.1.dist-info/entry_points.txt,sha256=FXlki7scg9b9vz0VKu3Xas23c0v_0daF8FoVZVA7rBU,353
+package_dev_tools-0.1.1.dist-info/top_level.txt,sha256=PqhxIcDJGvTSOvYGWFahqZFabfDh2COOD1aRPS_7WOg,18
+package_dev_tools-0.1.1.dist-info/RECORD,,

package_dev_tools-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.42.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

package_dev_tools-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+check-coverage = package_dev_tools.interfaces.cli.check_coverage:entry_point
+cleanup-readme = package_dev_tools.interfaces.cli.cleanup_readme:entry_point
+substitute-template-name = package_dev_tools.interfaces.cli.substitute_template_name:entry_point
+trigger-template-sync = package_dev_tools.interfaces.cli.cleanup_readme:entry_point

package_dev_tools-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+package_dev_tools