winipedia-utils 0.1.7__py3-none-any.whl → 0.1.9__py3-none-any.whl

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/projects/project.py

@@ -1,5 +1,7 @@
 """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
@@ -17,3 +19,30 @@ def _create_py_typed() -> None:
     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/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.dist-info → winipedia_utils-0.1.9.dist-info}/METADATA

@@ -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.dist-info → winipedia_utils-0.1.9.dist-info}/RECORD

@@ -14,7 +14,7 @@ winipedia_utils/git/__init__.py,sha256=pPo5DDqaQkFim8L6x22DXjqthLnKAxLyXlXl7JXGU
 winipedia_utils/git/gitignore/__init__.py,sha256=t65uvpOaNvh7ICgwuJFRr7vS2nWfxzWUGIpnJs0_jzE,58
 winipedia_utils/git/gitignore/gitignore.py,sha256=wCU2lRztTFKQ7JrKnCqPLCsuVRjfx8wGfTy42BLgFJI,4512
 winipedia_utils/git/pre_commit/__init__.py,sha256=2sBe5nOqmm3qb8YjhZzE4tCHhqxWOZ6R2ECljSVG7i4,59
-winipedia_utils/git/pre_commit/config.py,sha256=MUgk-43kd5l0cRk9VKzMQl88bDodsN8rSZcMzSzPpQw,1959
+winipedia_utils/git/pre_commit/config.py,sha256=gxRdR36_3ZLG_XcQsuGXApCsklCXvkc0_ToP1cpXPQk,2272
 winipedia_utils/git/pre_commit/hooks.py,sha256=Q6rXvbpUf9UasQ8vSBruoLA-wjm37jamvIUkXJ1B3FE,3210
 winipedia_utils/git/pre_commit/run_hooks.py,sha256=WoF1WDr07mS2GpKt0M-TpnuWfS0-Hwa4tP6z_9-JqlU,1572
 winipedia_utils/iterating/__init__.py,sha256=TZ0SSFA3zCJLk0z3IsLMxJqsfGzfxOSUKbQmwW-Dsqg,54
@@ -38,9 +38,9 @@ winipedia_utils/projects/__init__.py,sha256=6oTiSlUMAwO5xnH4SGVnvspzKcxrxo9kn1L4
 winipedia_utils/projects/poetry/__init__.py,sha256=0yNMuu9KmM19od4VBxBV3HLK-RdCsa0e2Zhg33J7RmQ,60
 winipedia_utils/projects/poetry/config.py,sha256=eEAU-9_uCEeOYx2lTAfydmH3D_YYTx6nOJ204q38BVY,2971
 winipedia_utils/projects/poetry/poetry.py,sha256=5jyUSMxhCZ7pz9bOaz5E9r7Da9qIrGOp6wcBzI1y7Cg,932
-winipedia_utils/projects/project.py,sha256=GRprpzhasBtV9OtPhQE2HxeufOzcJgbaCZbrW34YnnE,691
+winipedia_utils/projects/project.py,sha256=2nz1Hh51A-shjgdPCgiDw-ODrVtOtiHEHQnMPjAJZ-A,1587
 winipedia_utils/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-winipedia_utils/setup.py,sha256=zh02NliaF2RkP1iVONVp_LbNqoZCwcB7KmAdO8QmREU,1735
+winipedia_utils/setup.py,sha256=F4NneO0wVTf7JCXLorWjTOdJl36N5fLSksoWMe4p86o,1650
 winipedia_utils/testing/__init__.py,sha256=kXhB5xw02ec5xpcW_KV--9CBKdyCjnuR-NZzAJ5tq0g,51
 winipedia_utils/testing/assertions.py,sha256=0JF4mqVTnLQ1qkAL_FuTwyN_idr00rvVlta7aDdnUXA,851
 winipedia_utils/testing/convention.py,sha256=NxC_hYaUXshsa6LL6nQoEEKpTzC1KwTloKL8aS2gUPI,5010
@@ -61,7 +61,7 @@ winipedia_utils/testing/tests/base/utils/utils.py,sha256=dUPDrgAxlfREQb33zz23Mfz
 winipedia_utils/testing/tests/conftest.py,sha256=8RounBlI8Jq1aLaLNpv84MW4ne8Qq0aavQextDOp5ng,920
 winipedia_utils/text/__init__.py,sha256=j2bwtK6kyeHI6SnoBjpRju0C1W2n2paXBDlNjNtaUxA,48
 winipedia_utils/text/string.py,sha256=1jbBftlgxffGgSlPnQh3aRPIr8XekEwpSenjFCW6JyM,3478
-winipedia_utils-0.1.7.dist-info/LICENSE,sha256=3PrKJ2CWNrnyyHaC_r0wPDSukVWgmjOxHr__eQVH7cw,1087
-winipedia_utils-0.1.7.dist-info/METADATA,sha256=eCVD7jQppbQQ-DykP6cwgehnZHpzvVloNP2qbc0LEB0,12384
-winipedia_utils-0.1.7.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-winipedia_utils-0.1.7.dist-info/RECORD,,
+winipedia_utils-0.1.9.dist-info/LICENSE,sha256=3PrKJ2CWNrnyyHaC_r0wPDSukVWgmjOxHr__eQVH7cw,1087
+winipedia_utils-0.1.9.dist-info/METADATA,sha256=K-tV678jB4FVxS6eQzunfkIa0uUk_oem2VQagsLA7Y0,12384
+winipedia_utils-0.1.9.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+winipedia_utils-0.1.9.dist-info/RECORD,,