winipedia-utils 0.1.7__tar.gz → 0.1.9__tar.gz

{winipedia_utils-0.1.7 → winipedia_utils-0.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: winipedia-utils
-Version: 0.1.7
+Version: 0.1.9
 Summary: A package with many utility functions
 License: MIT
 Author: Winipedia

{winipedia_utils-0.1.7 → winipedia_utils-0.1.9}/pyproject.toml

@@ -1,7 +1,7 @@
 # Project section
 [project]
 name = "winipedia-utils"
-version = "0.1.7"
+version = "0.1.9"
 description = "A package with many utility functions"
 readme = "README.md"
 requires-python = ">=3.12"

{winipedia_utils-0.1.7 → winipedia_utils-0.1.9}/winipedia_utils/git/pre_commit/config.py

@@ -6,6 +6,8 @@ from typing import Any
 import yaml
 
 from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.os.os import run_subprocess
+from winipedia_utils.projects.poetry.poetry import POETRY_RUN_ARGS
 
 logger = get_logger(__name__)
 
@@ -58,3 +60,9 @@ def _add_package_hook_to_pre_commit_config() -> None:
         logger.info("Adding winipedia-utils hook to pre-commit config")
         config["repos"] = [package_hook_config, *config.get("repos", [])]
         dump_pre_commit_config(config)
+
+
+def _pre_commit_install() -> None:
+    """Install pre-commit."""
+    logger.info("Running pre-commit install")
+    run_subprocess([*POETRY_RUN_ARGS, "pre-commit", "install"], check=True)

winipedia_utils-0.1.9/winipedia_utils/projects/project.py

@@ -0,0 +1,48 @@
+"""Utilities for working with Python projects."""
+
+from types import ModuleType
+
+from winipedia_utils.modules.module import create_module, to_path
+from winipedia_utils.modules.package import get_src_package
+from winipedia_utils.projects.poetry.config import get_poetry_package_name
+
+
+def _create_project_root() -> None:
+    """Create the project root."""
+    src_package_name = get_poetry_package_name()
+    create_module(src_package_name, is_package=True)
+    _create_py_typed()
+
+
+def _create_py_typed() -> None:
+    """Create the py.typed file."""
+    src_package_name = get_src_package().__name__
+    py_typed_path = to_path(src_package_name, is_package=True) / "py.typed"
+    py_typed_path.touch()
+
+
+def make_name_from_package(
+    package: ModuleType,
+    split_on: str = "_",
+    join_on: str = "-",
+    *,
+    capitalize: bool = True,
+) -> str:
+    """Make a name from a package.
+
+    takes a package and makes a name from it that is readable by humans.
+
+    Args:
+        package (ModuleType): The package to make a name from
+        split_on (str, optional): what to split the package name on. Defaults to "_".
+        join_on (str, optional): what to join the package name with. Defaults to "-".
+        capitalize (bool, optional): Whether to capitalize each part. Defaults to True.
+
+    Returns:
+        str: _description_
+    """
+    package_name = package.__name__.split(".")[-1]
+    parts = package_name.split(split_on)
+    if capitalize:
+        parts = [part.capitalize() for part in parts]
+    return join_on.join(parts)

{winipedia_utils-0.1.7 → winipedia_utils-0.1.9}/winipedia_utils/setup.py

@@ -7,15 +7,16 @@ This script is intended to be called once at the beginning of a project.
 """
 
 from winipedia_utils.git.gitignore.gitignore import _add_package_patterns_to_gitignore
-from winipedia_utils.git.pre_commit.config import _add_package_hook_to_pre_commit_config
+from winipedia_utils.git.pre_commit.config import (
+    _add_package_hook_to_pre_commit_config,
+    _pre_commit_install,
+)
 from winipedia_utils.git.pre_commit.run_hooks import _run_all_hooks
 from winipedia_utils.logging.logger import get_logger
-from winipedia_utils.os.os import run_subprocess
 from winipedia_utils.projects.poetry.config import (
     _add_configurations_to_pyproject_toml,
 )
 from winipedia_utils.projects.poetry.poetry import (
-    POETRY_RUN_ARGS,
     _install_dev_dependencies,
 )
 from winipedia_utils.projects.project import _create_project_root
@@ -30,7 +31,7 @@ def _setup() -> None:
     # create pre-commit config
     _add_package_hook_to_pre_commit_config()
     # install pre-commit
-    run_subprocess([*POETRY_RUN_ARGS, "pre-commit", "install"], check=True)
+    _pre_commit_install()
     # add patterns to .gitignore
     _add_package_patterns_to_gitignore()
     # add tool.* configurations to pyproject.toml

winipedia_utils-0.1.7/winipedia_utils/projects/project.py

@@ -1,19 +0,0 @@
-"""Utilities for working with Python projects."""
-
-from winipedia_utils.modules.module import create_module, to_path
-from winipedia_utils.modules.package import get_src_package
-from winipedia_utils.projects.poetry.config import get_poetry_package_name
-
-
-def _create_project_root() -> None:
-    """Create the project root."""
-    src_package_name = get_poetry_package_name()
-    create_module(src_package_name, is_package=True)
-    _create_py_typed()
-
-
-def _create_py_typed() -> None:
-    """Create the py.typed file."""
-    src_package_name = get_src_package().__name__
-    py_typed_path = to_path(src_package_name, is_package=True) / "py.typed"
-    py_typed_path.touch()