winipedia-utils 0.4.29__tar.gz → 0.7.5__tar.gz

{winipedia_utils-0.4.29 → winipedia_utils-0.7.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.4.29
+Version: 0.7.5
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -15,6 +15,8 @@ Requires-Dist: cryptography
 Requires-Dist: defusedxml
 Requires-Dist: dotenv
 Requires-Dist: keyring
+Requires-Dist: networkx
+Requires-Dist: packaging
 Requires-Dist: pathspec
 Requires-Dist: polars
 Requires-Dist: pygithub
@@ -78,7 +80,8 @@ git clone https://github.com/owner/repo.git
 poetry init # or poetry new
 # 4: Poetry will ask you some stuff when you run poetry init.
 # First author name must be equal to the GitHub repository owner (username).
-# The repository name must be equal to the package/project name.
+# The repository name must be equal to the package/project name. 
+# (- instead of _ is fine, but only as the project name in pyproject.toml, folder names should all be _)
 
 # 5: Add winipedia-utils to your project
 poetry add winipedia-utils
@@ -103,13 +106,53 @@ The setup creates the following configuration files:
 - `.pre-commit-config.yaml` - Pre-commit hook configuration
 - `.gitignore` - Git ignore rules (assumes you added one on GitHub before.)
 - `pyproject.toml` - Project configuration with Poetry settings
-- `.github/workflows/health_check.yaml` - Health check workflow (Runs on every push and pull request)
+- `.github/workflows/health_check.yaml` - Health check workflow (Runs on every push and pull request using a matrix strategy to test across multiple operating systems and Python versions)
 - `.github/workflows/release.yaml` - Release workflow (Creates a release on GitHub when the same actions as in health check pass and commits are pushed to main)
 - `.github/workflows/publish.yaml` - Publishing workflow (Publishes to PyPI when a release is created by the release workflow, if you use this workflow, you need to add a PYPI_TOKEN (named PYPI_TOKEN) to your GitHub secrets that has write access to the package on PyPI.)
 - `py.typed` - PEP 561 marker for type hints
 - `experiment.py` - For experimentation (ignored by git)
 - `test_zero.py` - Test file with one empyt test (so that initial tests pass)
 - `conftest.py` - Pytest configuration file
+- `.python-version` - Python version file for pyenv (if you use pyenv, puts in the lowest supported python version in pyproject.toml opposed to the latest possible python version in workflows)
+
+### GitHub Workflows and Matrix Strategy
+
+The project uses GitHub Actions workflows with a **matrix strategy** to ensure cross-platform compatibility:
+
+#### Matrix Configuration
+
+The health check and release workflows test your code across:
+- **Operating Systems**: Ubuntu (latest), Windows (latest), macOS (latest)
+- **Python Versions**: All versions specified in your `pyproject.toml` (e.g., 3.12, 3.13, 3.14)
+
+This matrix strategy ensures your code works reliably across different environments before merging or releasing.
+
+#### Configuration File Structure
+Config Files are autogenerated via ConfigFile non-abstract subclasses.
+All nonabstract subclasses of ConfigFile are automatically created and managed when you commit or run pytest. winipedia_utils automatically discovers the pkg your_pkg.dev.configs and calls them. This way you can adjust or add some settings by subclassing. It is however important the parent class stays a subset of the child class according to the description in the function `nested_structure_is_subset` in `winipedia_utils.iterating.iterate` bc parents are still initialized and the order is not guaranteed.
+
+#### Workflow Structure
+
+Worklfows are a type of ConfigFile.
+
+The health check workflow consists of two jobs:
+
+1. **Matrix Job** (`health_check_matrix`) - Runs all checks in parallel across the matrix of OS and Python versions:
+   - Checkout repository
+   - Setup Git, Python, and Poetry
+   - Add Poetry to PATH (Windows-specific step)
+   - Install dependencies
+   - Setup CI keyring
+   - Protect repository (applies branch protection rules and repository settings)
+   - Run pre-commit hooks (linting, formatting, type checking, security, tests)
+
+2. **Aggregation Job** (`health_check`) - Aggregates matrix results into a single status check:
+   - Required for branch protection compatibility
+   - Only runs after all matrix jobs complete successfully
+   - Provides a single status check that can be marked as required in branch protection rules
+
+The release workflow extends the health check workflow and adds a release job that runs after all health checks pass.
+A build job is added before the release job if a src/dev/artifacts/builds exists with Builder subclasses. This script is created by the setup command and can be modified to create build artifacts for your project. Winipedia Utils automatically discovers all subclasses of Builder (dev.artifacts.builder) and calls them if the artifacts folder contains any files.
 
 ### Pre-commit Hook Workflow
 
@@ -117,21 +160,21 @@ When you commit code using `git commit`, the following checks run automatically:
 
 Info: If git commit fails bc of ModuleNotFoundError or smth similar, you need to run `poetry run git commit` instead.
 winipedia_utils hook is a python script that depends on winipedia_utils being installed. Poetry is needed to install winipedia_utils.
-Usually VSCode or other IDEs activates the venv automatically when opening the terminal but if not you need to activate it manually or run `poetry run git commit` instead.
-
-1. Patch version (poetry version patch)
-2. Add version patch to git (git add pyproject.toml)
-3. Update package manager (poetry self update)
-4. Install packages (poetry install --with dev)
-5. Update packages (poetry update --with dev (winipedia_utils forces all dependencies with * to be updated to latest compatible version))
-6. Lock dependencies (poetry lock)
-7. Check package manager configs (poetry check --strict)
-8. Create tests (python -m winipedia_utils.testing.create_tests)
-9. Lint code (ruff check --fix)
-10. Format code (ruff format)
-11. Check static types (mypy)
-12. Check security (bandit -c pyproject.toml -r .)
-13. Run tests (pytest (uses pyproject.toml as config))
+Usually VSCode or other IDEs activates the venv automatically when opening the terminal but if not you need to activate it manually or run `poetry run git commit` instead. It fails fast, so if one hook in winipedia_utils hook fails, the others don't run bc sys.exit(1) is called.
+
+Hooks run in the following order:
+
+- Update package manager (poetry self update)
+- Install packages (poetry install --with dev)
+- Update packages (poetry update --with dev (winipedia_utils forces all dependencies with * to be updated to latest compatible version))
+- Lock dependencies (poetry lock)
+- Check package manager configs (poetry check --strict)
+- Create tests (python -m winipedia_utils.dev.testing.create_tests)
+- Lint code (ruff check --fix)
+- Format code (ruff format)
+- Check static types (mypy)
+- Check security (bandit -c pyproject.toml -r .)
+- Run tests (pytest (uses pyproject.toml as config))
 
 ### Auto-generated Test Structure
 
@@ -151,6 +194,10 @@ my_project/
 
 For each function, class, and method, skeleton tests are created with `NotImplementedError` placeholders for you to implement.
 
+If you have autosuse fixtures just write and add them to the `tests/base/fixtures` directory. They will be automatically discovered, plugged into conftest and used in all tests according to defined scope.
+The filenames in the fixtures folder are just for organisation purposes for your convenience. You still have to 
+apply the pytest.fixture decorator to the fixture function and define the scope. So a session scoped function defined on function.py will still run as a session scoped fixture.
+
 ## Configuration Files
 
 Configuration files are managed automatically by the setup system:
@@ -159,10 +206,11 @@ Configuration files are managed automatically by the setup system:
 - **Empty files** - If you want to disable a config file, make it empty. This signals that the file is unwanted and won't be modified
 - **Custom additions** - You can add custom configurations as long as the standard configurations remain intact
 - **Modified standards** - If you modify the standard configurations, they will be restored on the next setup run
+- **Subclasses** - You can create custom config files by subclassing the standard ones. They will be automatically created and managed when you commit or run pytest. winipedia_utils automatically discovers and calls them. This way you can adjust or add some settings. It is however important the parent class stays a subset of the child class according to the description in the function `nested_structure_is_subset` in `winipedia_utils.iterating.iterate`.
 
 ## Branch Protection
 
-As soon as you push to `main` on GitHub (provided the `REPO_TOKEN` secret is set up correctly), the `health_check.yaml` workflow will run and execute `winipedia_utils.git.github.repo.protect`, which uses PyGithub to protect the repository.
+As soon as you push to `main` on GitHub (provided the `REPO_TOKEN` secret is set up correctly), the `health_check.yaml` workflow will run and execute `winipedia_utils.dev.git.github.repo.protect`, which uses PyGithub to protect the repository.
 
 ### Repository Settings
 
@@ -195,8 +243,8 @@ A ruleset named `main protection` is created for the `main` branch with the foll
   - Requires review thread resolution (all comments in reviews must be resolved before merge)
   - Allowed merge methods: `squash` and `rebase` (no merge commits, keeps history clean)
 - **Required Status Checks:**
-  - Strict mode enabled (all status checks must pass on the latest commit, not older ones (sets the health check as required status check))
-  - Health check workflow must pass (the CI/CD pipeline must complete successfully)
+  - Strict mode enabled (all status checks must pass on the latest commit, not older ones)
+  - Health check workflow must pass (the aggregated `health_check` job ensures all matrix combinations passed successfully)
 - **Bypass Actors** - Repository admins can bypass all rules (for emergency situations)
 
 ## Utilities
@@ -208,8 +256,8 @@ Winipedia Utils provides comprehensive utility modules for common development ta
 Unified interface for multiprocessing and multithreading:
 
 ```python
-from winipedia_utils.concurrent.multiprocessing import multiprocess_loop
-from winipedia_utils.concurrent.multithreading import multithread_loop
+from winipedia_utils.utils.iterating.concurrent.multiprocessing import multiprocess_loop
+from winipedia_utils.utils.iterating.concurrent.multithreading import multithread_loop
 ```
 
 ### Data Cleaning & Handling
@@ -217,7 +265,7 @@ from winipedia_utils.concurrent.multithreading import multithread_loop
 Build data cleaning pipelines using Polars:
 
 ```python
-from winipedia_utils.data.dataframe.cleaning import CleaningDF
+from winipedia_utils.utils.data.dataframe.cleaning import CleaningDF
 import polars as pl
 ```
 
@@ -226,7 +274,7 @@ import polars as pl
 Simple, standardized logging setup with automatic method instrumentation:
 
 ```python
-from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.utils.logging.logger import get_logger
 
 logger = get_logger(__name__)
 logger.info("Application started")
@@ -244,7 +292,7 @@ logger.error("An error occurred")
 Advanced metaclasses and mixins for class composition and behavior extension:
 
 ```python
-from winipedia_utils.oop.mixins.mixin import ABCLoggingMixin, StrictABCLoggingMixin
+from winipedia_utils.utils.oop.mixins.mixin import ABCLoggingMixin, StrictABCLoggingMixin
 ```
 
 ### Security Utilities
@@ -252,7 +300,7 @@ from winipedia_utils.oop.mixins.mixin import ABCLoggingMixin, StrictABCLoggingMi
 Encryption and secure credential storage using keyring:
 
 ```python
-from winipedia_utils.security.keyring import (
+from winipedia_utils.utils.security.keyring import (
     get_or_create_fernet,
     get_or_create_aes_gcm
 )
@@ -263,8 +311,8 @@ from winipedia_utils.security.keyring import (
 Comprehensive testing framework with automatic test generation:
 
 ```python
-from winipedia_utils.testing.assertions import assert_with_msg
-from winipedia_utils.testing.convention import (
+from winipedia_utils.utils.testing.assertions import assert_with_msg
+from winipedia_utils.dev.testing.convention import (
     make_test_obj_name,
     get_test_obj_from_obj,
     make_test_obj_importpath_from_obj
@@ -294,10 +342,10 @@ test_path = make_test_obj_importpath_from_obj(my_function)
 Tools for working with Python modules, packages, classes, and functions:
 
 ```python
-from winipedia_utils.modules.package import find_packages, walk_package
-from winipedia_utils.modules.module import create_module, import_obj_from_importpath
-from winipedia_utils.modules.class_ import get_all_cls_from_module, get_all_methods_from_cls
-from winipedia_utils.modules.function import get_all_functions_from_module
+from winipedia_utils.utils.modules.package import find_packages, walk_package
+from winipedia_utils.utils.modules.module import create_module, import_obj_from_importpath
+from winipedia_utils.utils.modules.class_ import get_all_cls_from_module, get_all_methods_from_cls
+from winipedia_utils.utils.modules.function import get_all_functions_from_module
 ```
 
 ### Text and String Utilities
@@ -305,7 +353,7 @@ from winipedia_utils.modules.function import get_all_functions_from_module
 String manipulation and configuration file handling:
 
 ```python
-from winipedia_utils.text.string import value_to_truncated_string
+from winipedia_utils.utils.data.structures.text.string import value_to_truncated_string
 ```
 
 ### OS and System Utilities
@@ -313,7 +361,7 @@ from winipedia_utils.text.string import value_to_truncated_string
 Operating system and subprocess utilities:
 
 ```python
-from winipedia_utils.os.os import run_subprocess
+from winipedia_utils.utils.os.os import run_subprocess
 ```
 
 ### Iteration Utilities
@@ -321,7 +369,7 @@ from winipedia_utils.os.os import run_subprocess
 Utilities for working with iterables and nested structures:
 
 ```python
-from winipedia_utils.iterating.iterate import get_len_with_default, nested_structure_is_subset
+from winipedia_utils.utils.iterating.iterate import get_len_with_default, nested_structure_is_subset
 ```
 
 ### Philosophy

{winipedia_utils-0.4.29 → winipedia_utils-0.7.5}/README.md

@@ -52,7 +52,8 @@ git clone https://github.com/owner/repo.git
 poetry init # or poetry new
 # 4: Poetry will ask you some stuff when you run poetry init.
 # First author name must be equal to the GitHub repository owner (username).
-# The repository name must be equal to the package/project name.
+# The repository name must be equal to the package/project name. 
+# (- instead of _ is fine, but only as the project name in pyproject.toml, folder names should all be _)
 
 # 5: Add winipedia-utils to your project
 poetry add winipedia-utils
@@ -77,13 +78,53 @@ The setup creates the following configuration files:
 - `.pre-commit-config.yaml` - Pre-commit hook configuration
 - `.gitignore` - Git ignore rules (assumes you added one on GitHub before.)
 - `pyproject.toml` - Project configuration with Poetry settings
-- `.github/workflows/health_check.yaml` - Health check workflow (Runs on every push and pull request)
+- `.github/workflows/health_check.yaml` - Health check workflow (Runs on every push and pull request using a matrix strategy to test across multiple operating systems and Python versions)
 - `.github/workflows/release.yaml` - Release workflow (Creates a release on GitHub when the same actions as in health check pass and commits are pushed to main)
 - `.github/workflows/publish.yaml` - Publishing workflow (Publishes to PyPI when a release is created by the release workflow, if you use this workflow, you need to add a PYPI_TOKEN (named PYPI_TOKEN) to your GitHub secrets that has write access to the package on PyPI.)
 - `py.typed` - PEP 561 marker for type hints
 - `experiment.py` - For experimentation (ignored by git)
 - `test_zero.py` - Test file with one empyt test (so that initial tests pass)
 - `conftest.py` - Pytest configuration file
+- `.python-version` - Python version file for pyenv (if you use pyenv, puts in the lowest supported python version in pyproject.toml opposed to the latest possible python version in workflows)
+
+### GitHub Workflows and Matrix Strategy
+
+The project uses GitHub Actions workflows with a **matrix strategy** to ensure cross-platform compatibility:
+
+#### Matrix Configuration
+
+The health check and release workflows test your code across:
+- **Operating Systems**: Ubuntu (latest), Windows (latest), macOS (latest)
+- **Python Versions**: All versions specified in your `pyproject.toml` (e.g., 3.12, 3.13, 3.14)
+
+This matrix strategy ensures your code works reliably across different environments before merging or releasing.
+
+#### Configuration File Structure
+Config Files are autogenerated via ConfigFile non-abstract subclasses.
+All nonabstract subclasses of ConfigFile are automatically created and managed when you commit or run pytest. winipedia_utils automatically discovers the pkg your_pkg.dev.configs and calls them. This way you can adjust or add some settings by subclassing. It is however important the parent class stays a subset of the child class according to the description in the function `nested_structure_is_subset` in `winipedia_utils.iterating.iterate` bc parents are still initialized and the order is not guaranteed.
+
+#### Workflow Structure
+
+Worklfows are a type of ConfigFile.
+
+The health check workflow consists of two jobs:
+
+1. **Matrix Job** (`health_check_matrix`) - Runs all checks in parallel across the matrix of OS and Python versions:
+   - Checkout repository
+   - Setup Git, Python, and Poetry
+   - Add Poetry to PATH (Windows-specific step)
+   - Install dependencies
+   - Setup CI keyring
+   - Protect repository (applies branch protection rules and repository settings)
+   - Run pre-commit hooks (linting, formatting, type checking, security, tests)
+
+2. **Aggregation Job** (`health_check`) - Aggregates matrix results into a single status check:
+   - Required for branch protection compatibility
+   - Only runs after all matrix jobs complete successfully
+   - Provides a single status check that can be marked as required in branch protection rules
+
+The release workflow extends the health check workflow and adds a release job that runs after all health checks pass.
+A build job is added before the release job if a src/dev/artifacts/builds exists with Builder subclasses. This script is created by the setup command and can be modified to create build artifacts for your project. Winipedia Utils automatically discovers all subclasses of Builder (dev.artifacts.builder) and calls them if the artifacts folder contains any files.
 
 ### Pre-commit Hook Workflow
 
@@ -91,21 +132,21 @@ When you commit code using `git commit`, the following checks run automatically:
 
 Info: If git commit fails bc of ModuleNotFoundError or smth similar, you need to run `poetry run git commit` instead.
 winipedia_utils hook is a python script that depends on winipedia_utils being installed. Poetry is needed to install winipedia_utils.
-Usually VSCode or other IDEs activates the venv automatically when opening the terminal but if not you need to activate it manually or run `poetry run git commit` instead.
-
-1. Patch version (poetry version patch)
-2. Add version patch to git (git add pyproject.toml)
-3. Update package manager (poetry self update)
-4. Install packages (poetry install --with dev)
-5. Update packages (poetry update --with dev (winipedia_utils forces all dependencies with * to be updated to latest compatible version))
-6. Lock dependencies (poetry lock)
-7. Check package manager configs (poetry check --strict)
-8. Create tests (python -m winipedia_utils.testing.create_tests)
-9. Lint code (ruff check --fix)
-10. Format code (ruff format)
-11. Check static types (mypy)
-12. Check security (bandit -c pyproject.toml -r .)
-13. Run tests (pytest (uses pyproject.toml as config))
+Usually VSCode or other IDEs activates the venv automatically when opening the terminal but if not you need to activate it manually or run `poetry run git commit` instead. It fails fast, so if one hook in winipedia_utils hook fails, the others don't run bc sys.exit(1) is called.
+
+Hooks run in the following order:
+
+- Update package manager (poetry self update)
+- Install packages (poetry install --with dev)
+- Update packages (poetry update --with dev (winipedia_utils forces all dependencies with * to be updated to latest compatible version))
+- Lock dependencies (poetry lock)
+- Check package manager configs (poetry check --strict)
+- Create tests (python -m winipedia_utils.dev.testing.create_tests)
+- Lint code (ruff check --fix)
+- Format code (ruff format)
+- Check static types (mypy)
+- Check security (bandit -c pyproject.toml -r .)
+- Run tests (pytest (uses pyproject.toml as config))
 
 ### Auto-generated Test Structure
 
@@ -125,6 +166,10 @@ my_project/
 
 For each function, class, and method, skeleton tests are created with `NotImplementedError` placeholders for you to implement.
 
+If you have autosuse fixtures just write and add them to the `tests/base/fixtures` directory. They will be automatically discovered, plugged into conftest and used in all tests according to defined scope.
+The filenames in the fixtures folder are just for organisation purposes for your convenience. You still have to 
+apply the pytest.fixture decorator to the fixture function and define the scope. So a session scoped function defined on function.py will still run as a session scoped fixture.
+
 ## Configuration Files
 
 Configuration files are managed automatically by the setup system:
@@ -133,10 +178,11 @@ Configuration files are managed automatically by the setup system:
 - **Empty files** - If you want to disable a config file, make it empty. This signals that the file is unwanted and won't be modified
 - **Custom additions** - You can add custom configurations as long as the standard configurations remain intact
 - **Modified standards** - If you modify the standard configurations, they will be restored on the next setup run
+- **Subclasses** - You can create custom config files by subclassing the standard ones. They will be automatically created and managed when you commit or run pytest. winipedia_utils automatically discovers and calls them. This way you can adjust or add some settings. It is however important the parent class stays a subset of the child class according to the description in the function `nested_structure_is_subset` in `winipedia_utils.iterating.iterate`.
 
 ## Branch Protection
 
-As soon as you push to `main` on GitHub (provided the `REPO_TOKEN` secret is set up correctly), the `health_check.yaml` workflow will run and execute `winipedia_utils.git.github.repo.protect`, which uses PyGithub to protect the repository.
+As soon as you push to `main` on GitHub (provided the `REPO_TOKEN` secret is set up correctly), the `health_check.yaml` workflow will run and execute `winipedia_utils.dev.git.github.repo.protect`, which uses PyGithub to protect the repository.
 
 ### Repository Settings
 
@@ -169,8 +215,8 @@ A ruleset named `main protection` is created for the `main` branch with the foll
   - Requires review thread resolution (all comments in reviews must be resolved before merge)
   - Allowed merge methods: `squash` and `rebase` (no merge commits, keeps history clean)
 - **Required Status Checks:**
-  - Strict mode enabled (all status checks must pass on the latest commit, not older ones (sets the health check as required status check))
-  - Health check workflow must pass (the CI/CD pipeline must complete successfully)
+  - Strict mode enabled (all status checks must pass on the latest commit, not older ones)
+  - Health check workflow must pass (the aggregated `health_check` job ensures all matrix combinations passed successfully)
 - **Bypass Actors** - Repository admins can bypass all rules (for emergency situations)
 
 ## Utilities
@@ -182,8 +228,8 @@ Winipedia Utils provides comprehensive utility modules for common development ta
 Unified interface for multiprocessing and multithreading:
 
 ```python
-from winipedia_utils.concurrent.multiprocessing import multiprocess_loop
-from winipedia_utils.concurrent.multithreading import multithread_loop
+from winipedia_utils.utils.iterating.concurrent.multiprocessing import multiprocess_loop
+from winipedia_utils.utils.iterating.concurrent.multithreading import multithread_loop
 ```
 
 ### Data Cleaning & Handling
@@ -191,7 +237,7 @@ from winipedia_utils.concurrent.multithreading import multithread_loop
 Build data cleaning pipelines using Polars:
 
 ```python
-from winipedia_utils.data.dataframe.cleaning import CleaningDF
+from winipedia_utils.utils.data.dataframe.cleaning import CleaningDF
 import polars as pl
 ```
 
@@ -200,7 +246,7 @@ import polars as pl
 Simple, standardized logging setup with automatic method instrumentation:
 
 ```python
-from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.utils.logging.logger import get_logger
 
 logger = get_logger(__name__)
 logger.info("Application started")
@@ -218,7 +264,7 @@ logger.error("An error occurred")
 Advanced metaclasses and mixins for class composition and behavior extension:
 
 ```python
-from winipedia_utils.oop.mixins.mixin import ABCLoggingMixin, StrictABCLoggingMixin
+from winipedia_utils.utils.oop.mixins.mixin import ABCLoggingMixin, StrictABCLoggingMixin
 ```
 
 ### Security Utilities
@@ -226,7 +272,7 @@ from winipedia_utils.oop.mixins.mixin import ABCLoggingMixin, StrictABCLoggingMi
 Encryption and secure credential storage using keyring:
 
 ```python
-from winipedia_utils.security.keyring import (
+from winipedia_utils.utils.security.keyring import (
     get_or_create_fernet,
     get_or_create_aes_gcm
 )
@@ -237,8 +283,8 @@ from winipedia_utils.security.keyring import (
 Comprehensive testing framework with automatic test generation:
 
 ```python
-from winipedia_utils.testing.assertions import assert_with_msg
-from winipedia_utils.testing.convention import (
+from winipedia_utils.utils.testing.assertions import assert_with_msg
+from winipedia_utils.dev.testing.convention import (
     make_test_obj_name,
     get_test_obj_from_obj,
     make_test_obj_importpath_from_obj
@@ -268,10 +314,10 @@ test_path = make_test_obj_importpath_from_obj(my_function)
 Tools for working with Python modules, packages, classes, and functions:
 
 ```python
-from winipedia_utils.modules.package import find_packages, walk_package
-from winipedia_utils.modules.module import create_module, import_obj_from_importpath
-from winipedia_utils.modules.class_ import get_all_cls_from_module, get_all_methods_from_cls
-from winipedia_utils.modules.function import get_all_functions_from_module
+from winipedia_utils.utils.modules.package import find_packages, walk_package
+from winipedia_utils.utils.modules.module import create_module, import_obj_from_importpath
+from winipedia_utils.utils.modules.class_ import get_all_cls_from_module, get_all_methods_from_cls
+from winipedia_utils.utils.modules.function import get_all_functions_from_module
 ```
 
 ### Text and String Utilities
@@ -279,7 +325,7 @@ from winipedia_utils.modules.function import get_all_functions_from_module
 String manipulation and configuration file handling:
 
 ```python
-from winipedia_utils.text.string import value_to_truncated_string
+from winipedia_utils.utils.data.structures.text.string import value_to_truncated_string
 ```
 
 ### OS and System Utilities
@@ -287,7 +333,7 @@ from winipedia_utils.text.string import value_to_truncated_string
 Operating system and subprocess utilities:
 
 ```python
-from winipedia_utils.os.os import run_subprocess
+from winipedia_utils.utils.os.os import run_subprocess
 ```
 
 ### Iteration Utilities
@@ -295,7 +341,7 @@ from winipedia_utils.os.os import run_subprocess
 Utilities for working with iterables and nested structures:
 
 ```python
-from winipedia_utils.iterating.iterate import get_len_with_default, nested_structure_is_subset
+from winipedia_utils.utils.iterating.iterate import get_len_with_default, nested_structure_is_subset
 ```
 
 ### Philosophy

{winipedia_utils-0.4.29 → winipedia_utils-0.7.5}/pyproject.toml

@@ -1,17 +1,17 @@
 # Project section
 [project]
 name = "winipedia-utils"
-version = "0.4.29"
+version = "0.7.5"
 description = "A package with many utility functions"
 readme = "README.md"
 requires-python = ">=3.12"
-dynamic = [ "dependencies",]
 authors = [
     { name = "Winipedia", email = "win.steveker@gmx.de"}
 ]
 license = "MIT"
+dynamic = ["dependencies"]
 
-# Build system section
+# Build system section[build-system]
 [build-system]
 requires = [ "poetry-core>=2.0.0,<3.0.0",]
 build-backend = "poetry.core.masonry.api"
@@ -21,17 +21,19 @@ build-backend = "poetry.core.masonry.api"
 include = "winipedia_utils"
 
 [tool.poetry.dependencies]
-tqdm = "*"
+networkx = "*"
 setuptools = "*"
-defusedxml = "*"
-tomlkit = "*"
-pathspec = "*"
 pyyaml = "*"
-keyring = "*"
-cryptography = "*"
+packaging = "*"
 polars = "*"
+tomlkit = "*"
+cryptography = "*"
+tqdm = "*"
 pygithub = "*"
 dotenv = "*"
+pathspec = "*"
+defusedxml = "*"
+keyring = "*"
 
 [tool.poetry.group.dev.dependencies]
 ruff = "*"
@@ -44,6 +46,7 @@ types-tqdm = "*"
 types-defusedxml = "*"
 types-pyyaml = "*"
 pytest-mock = "*"
+types-networkx = "*"
 
 [tool.ruff]
 exclude = [ ".*", "**/migrations/*.py",]
@@ -64,3 +67,4 @@ files = "."
 testpaths = [ "tests",]
 
 [tool.bandit]
+exclude_dirs = ["experiment.py"]

winipedia_utils-0.7.5/winipedia_utils/dev/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

winipedia_utils-0.7.5/winipedia_utils/dev/artifacts/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""

winipedia_utils-0.7.5/winipedia_utils/dev/artifacts/build.py

@@ -0,0 +1,6 @@
+"""Build artifacts for the project."""
+
+from winipedia_utils.dev.artifacts.builder import Builder
+
+if __name__ == "__main__":
+    Builder.init_all_non_abstract_subclasses()

winipedia_utils-0.7.5/winipedia_utils/dev/artifacts/builder.py

@@ -0,0 +1,96 @@
+"""Build utilities for creating and managing project builds.
+
+This module provides functions for building and managing project artifacts,
+including creating build scripts, configuring build environments, and
+handling build dependencies. These utilities help with the packaging and
+distribution of project code.
+"""
+
+import platform
+from abc import abstractmethod
+from importlib import import_module
+from pathlib import Path
+
+from winipedia_utils.dev.configs.builder import BuilderConfigFile
+from winipedia_utils.utils.modules.class_ import (
+    get_all_nonabstract_subclasses,
+)
+from winipedia_utils.utils.modules.module import to_module_name, to_path
+from winipedia_utils.utils.oop.mixins.mixin import ABCLoggingMixin
+
+
+class Builder(ABCLoggingMixin):
+    """Base class for build scripts.
+
+    Subclass this class and implement the get_artifacts method to create
+    a build script for your project. The build method will be called
+    automatically when the class is initialized. At the end of the file add
+    if __name__ == "__main__":
+        YourBuildClass()
+    """
+
+    ARTIFACTS_DIR_NAME = "artifacts"
+    ARTIFACTS_PATH = Path(ARTIFACTS_DIR_NAME)
+
+    @classmethod
+    @abstractmethod
+    def create_artifacts(cls) -> None:
+        """Build the project.
+
+        This method should create all artifacts in the ARTIFACTS_PATH folder.
+
+        Returns:
+            None
+        """
+
+    @classmethod
+    def __init__(cls) -> None:
+        """Initialize the build script."""
+        cls.build()
+
+    @classmethod
+    def build(cls) -> None:
+        """Build the project.
+
+        This method is called by the __init__ method.
+        It takes all the files and renames them with -platform.system()
+        and puts them in the artifacts folder.
+        """
+        cls.ARTIFACTS_PATH.mkdir(parents=True, exist_ok=True)
+        cls.create_artifacts()
+        artifacts = cls.get_artifacts()
+        for artifact in artifacts:
+            parent = artifact.parent
+            if parent != cls.ARTIFACTS_PATH:
+                msg = f"You must create {artifact} in {cls.ARTIFACTS_PATH}"
+                raise FileNotFoundError(msg)
+
+            # rename the files with -platform.system()
+            new_name = f"{artifact.stem}-{platform.system()}{artifact.suffix}"
+            new_path = cls.ARTIFACTS_PATH / new_name
+            artifact.rename(new_path)
+
+    @classmethod
+    def get_artifacts(cls) -> list[Path]:
+        """Get the built artifacts."""
+        paths = list(cls.ARTIFACTS_PATH.glob("*"))
+        if not paths:
+            msg = f"Expected {cls.ARTIFACTS_PATH} to contain files"
+            raise FileNotFoundError(msg)
+        return paths
+
+    @classmethod
+    def get_non_abstract_subclasses(cls) -> set[type["Builder"]]:
+        """Get all non-abstract subclasses of Builder."""
+        path = BuilderConfigFile.get_parent_path()
+        module_name = to_module_name(path)
+        if not to_path(module_name, is_package=True).exists():
+            return set()
+        builds_pkg = import_module(module_name)
+        return get_all_nonabstract_subclasses(cls, load_package_before=builds_pkg)
+
+    @classmethod
+    def init_all_non_abstract_subclasses(cls) -> None:
+        """Build all artifacts."""
+        for builder in cls.get_non_abstract_subclasses():
+            builder()

winipedia_utils-0.7.5/winipedia_utils/dev/artifacts/builds/__init__.py

@@ -0,0 +1 @@
+"""__init__ module."""