winipedia-utils 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

winipedia_utils/modules/package.py

@@ -28,7 +28,7 @@ from winipedia_utils.logging.logger import get_logger
 logger = get_logger(__name__)
 
 
-def get_scr_package() -> ModuleType:
+def get_src_package() -> ModuleType:
     """Identify and return the main source package of the project.
 
     Discovers the main source package by finding all top-level packages

winipedia_utils/projects/project.py

@@ -0,0 +1,19 @@
+"""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()

winipedia_utils/py.typed

@@ -0,0 +1 @@
+

winipedia_utils/setup.py

@@ -16,6 +16,7 @@ from winipedia_utils.projects.poetry.config import (
 from winipedia_utils.projects.poetry.poetry import (
     _install_dev_dependencies,
 )
+from winipedia_utils.projects.project import _create_project_root
 
 logger = get_logger(__name__)
 
@@ -30,6 +31,8 @@ def _setup() -> None:
     _add_package_patterns_to_gitignore()
     # add tool.* configurations to pyproject.toml
     _add_configurations_to_pyproject_toml()
+    # create the project root
+    _create_project_root()
     # run pre-commit once, create tests is included here
     _run_all_hooks()
     logger.info("Setup complete!")

winipedia_utils/testing/create_tests.py

@@ -24,7 +24,7 @@ from winipedia_utils.modules.module import (
 )
 from winipedia_utils.modules.package import (
     copy_package,
-    get_scr_package,
+    get_src_package,
     walk_package,
 )
 from winipedia_utils.testing import tests
@@ -80,7 +80,7 @@ def create_tests_for_src_package() -> None:
     This function walks through the source package hierarchy and creates corresponding
     test packages and modules for each package and module found in the source.
     """
-    src_package = get_scr_package()
+    src_package = get_src_package()
     for package, modules in walk_package(src_package):
         create_test_package(package)
         for module in modules:

winipedia_utils/testing/tests/base/fixtures/scopes/session.py

@@ -17,7 +17,7 @@ from winipedia_utils.git.pre_commit.config import (
 from winipedia_utils.modules.module import to_path
 from winipedia_utils.modules.package import (
     find_packages,
-    get_scr_package,
+    get_src_package,
     walk_package,
 )
 from winipedia_utils.projects.poetry.config import (
@@ -188,7 +188,7 @@ def _test_all_src_code_in_one_package() -> None:
 
     """
     packages = find_packages(depth=0)
-    src_package = get_scr_package().__name__
+    src_package = get_src_package().__name__
     expected_packages = {TESTS_PACKAGE_NAME, src_package}
     assert_with_msg(
         set(packages) == expected_packages,
@@ -196,6 +196,44 @@ def _test_all_src_code_in_one_package() -> None:
     )
 
 
+@autouse_session_fixture
+def _test_src_package_correctly_named() -> None:
+    """Verify that the source package is correctly named.
+
+    This fixture runs once per test session and checks that the source package
+    is correctly named after the project.
+
+    Raises:
+        AssertionError: If the source package is not correctly named
+
+    """
+    src_package = get_src_package().__name__
+    assert_with_msg(
+        src_package == get_poetry_package_name(),
+        f"Expected source package to be named {get_poetry_package_name()}, "
+        f"but it is named {src_package}",
+    )
+
+
+@autouse_session_fixture
+def _test_py_typed_exists() -> None:
+    """Verify that the py.typed file exists in the source package.
+
+    This fixture runs once per test session and checks that the py.typed file
+    exists in the source package.
+
+    Raises:
+        AssertionError: If the py.typed file doesn't exist
+
+    """
+    src_package = get_src_package()
+    py_typed_path = to_path(src_package.__name__, is_package=True) / "py.typed"
+    assert_with_msg(
+        py_typed_path.exists(),
+        f"Expected py.typed file to exist at {py_typed_path}",
+    )
+
+
 @autouse_session_fixture
 def _test_project_structure_mirrored() -> None:
     """Verify that the project structure is mirrored in tests.
@@ -207,7 +245,7 @@ def _test_project_structure_mirrored() -> None:
         AssertionError: If any package or module doesn't have a corresponding test
 
     """
-    src_package = get_scr_package()
+    src_package = get_src_package()
 
     # we will now go through all the modules in the src package and check
     # that there is a corresponding test module

{winipedia_utils-0.1.2.dist-info → winipedia_utils-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: winipedia-utils
-Version: 0.1.2
+Version: 0.1.4
 Summary: A package with many utility functions
 License: MIT
 Author: Winipedia
@@ -150,11 +150,11 @@ create_tests()
 ### Module Introspection
 
 ```python
-from winipedia_utils.modules.package import get_scr_package, walk_package
+from winipedia_utils.modules.package import get_src_package, walk_package
 from winipedia_utils.modules.function import get_all_functions_from_module
 
 # Discover your main source package
-src_package = get_scr_package()
+src_package = get_src_package()
 
 # Walk through all modules in a package
 for package, modules in walk_package(src_package):

{winipedia_utils-0.1.2.dist-info → winipedia_utils-0.1.4.dist-info}/RECORD

@@ -27,7 +27,7 @@ winipedia_utils/modules/__init__.py,sha256=e3CFaC3FhK4ibknFOv1bqOZxA7XeVwmLqWX7o
 winipedia_utils/modules/class_.py,sha256=RDjal6QYYs9z81DT1mIFrnEhQ9vgN2tCAYN1WWnN24Y,2462
 winipedia_utils/modules/function.py,sha256=Qn1OPV5dwO-7f3a0f0RpWcrH-E9teGPwldRtwbFYzRM,2551
 winipedia_utils/modules/module.py,sha256=iJwUJPhVkxyRjJqHVVWh3GNJFiYf45ZdSfR21puQAmw,12673
-winipedia_utils/modules/package.py,sha256=77DiJmIUrsSsJHAdBZwA8iCi5gv2KSmFCwYyF1uvWLw,12485
+winipedia_utils/modules/package.py,sha256=jPI7fcJ5VFWO7nRvjB6cGv_mahx0BUej9qhKARSK_Vk,12485
 winipedia_utils/oop/__init__.py,sha256=wGjsVwLbTVEQWOfDJvN9nlvC-3NmAi8Doc2xIrm6e78,47
 winipedia_utils/oop/mixins/__init__.py,sha256=PDK-cJcdRUfDUCz36qQ5pmMW07G133WtN49OpmILGNI,54
 winipedia_utils/oop/mixins/meta.py,sha256=UpHags1j80OABxW4Q3QYt7A7lLIArvgUrGcWeYJaRyU,10576
@@ -38,11 +38,13 @@ 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/setup.py,sha256=ibctor1iexlqOqwqh8uPQqCQAqXKJmkwNhJRx0A_SBc,1434
+winipedia_utils/projects/project.py,sha256=GRprpzhasBtV9OtPhQE2HxeufOzcJgbaCZbrW34YnnE,691
+winipedia_utils/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+winipedia_utils/setup.py,sha256=6zOT-5kXqpADg6wYf-S4ghEY38No_LDQL0YaIRQCFJ0,1560
 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
-winipedia_utils/testing/create_tests.py,sha256=9SrmzyMD7yPKCoLKkM0i_wRASHw2hJ_61sNuvZtYmt4,9820
+winipedia_utils/testing/create_tests.py,sha256=pfjPBFWw0yFd8x0LG5Ym8ohFgjOJ34O0HAGoowKJpcY,9820
 winipedia_utils/testing/fixtures.py,sha256=e0ax1n1zqzmLawA26k0EtNa3rYSMu10lMNVRjBuIGMs,1061
 winipedia_utils/testing/tests/__init__.py,sha256=kL-1O6lAO5j4JPOqPdi3dHdbOQ_UXcgPFppj82HhrRU,57
 winipedia_utils/testing/tests/base/__init__.py,sha256=dBH1yfONmqUC49zshS6BJ4ZgEcw7iFGoFCqRmU7Vhrw,62
@@ -53,13 +55,13 @@ winipedia_utils/testing/tests/base/fixtures/scopes/class_.py,sha256=XCx4HZeHbJJ-
 winipedia_utils/testing/tests/base/fixtures/scopes/function.py,sha256=5dW7-IPqJ_3Q2j1vftZL5FYKvNSKufqiHzLTTWYhja4,309
 winipedia_utils/testing/tests/base/fixtures/scopes/module.py,sha256=V0H9WFrdSV7uj__bXM_GKcCJnjResqI7fFjcxyvNaZk,1169
 winipedia_utils/testing/tests/base/fixtures/scopes/package.py,sha256=IKOfj6vfyjEQdRV5cJoPRQvALmePpGxWkGy23di00-w,309
-winipedia_utils/testing/tests/base/fixtures/scopes/session.py,sha256=CP-CY_qsa2bc8FCIvb64LaB_G0C43eGa3Rt8QtnY4LQ,8435
+winipedia_utils/testing/tests/base/fixtures/scopes/session.py,sha256=Wdesvis8BleXjm93jK99JLX4u9Oy2dY0GIx_3ipXYXo,9624
 winipedia_utils/testing/tests/base/utils/__init__.py,sha256=mC-8dCkp8xarqkQu2QQLrPjHi6Ww9hcixWdHeQHWeRs,68
 winipedia_utils/testing/tests/base/utils/utils.py,sha256=dUPDrgAxlfREQb33zz23MfzacLLuwjy2AO-PQQp_aSI,2820
 winipedia_utils/testing/tests/conftest.py,sha256=CvLtsr-KhSPzbQYin6SYZQC1Ez3AzIsqCWhuLuXinAs,826
 winipedia_utils/text/__init__.py,sha256=j2bwtK6kyeHI6SnoBjpRju0C1W2n2paXBDlNjNtaUxA,48
 winipedia_utils/text/string.py,sha256=1jbBftlgxffGgSlPnQh3aRPIr8XekEwpSenjFCW6JyM,3478
-winipedia_utils-0.1.2.dist-info/LICENSE,sha256=3PrKJ2CWNrnyyHaC_r0wPDSukVWgmjOxHr__eQVH7cw,1087
-winipedia_utils-0.1.2.dist-info/METADATA,sha256=1necjUNHVaT6j4Th5Wru3QJRY8LNunEV7i7vgk5rY4Q,12384
-winipedia_utils-0.1.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-winipedia_utils-0.1.2.dist-info/RECORD,,
+winipedia_utils-0.1.4.dist-info/LICENSE,sha256=3PrKJ2CWNrnyyHaC_r0wPDSukVWgmjOxHr__eQVH7cw,1087
+winipedia_utils-0.1.4.dist-info/METADATA,sha256=rIJjj27ZrZ5S0jkXaQPzau4lD3Vx-xKKpST4Y_DPt6A,12384
+winipedia_utils-0.1.4.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+winipedia_utils-0.1.4.dist-info/RECORD,,