winipedia-utils 0.4.53__tar.gz → 0.6.7__tar.gz

{winipedia_utils-0.4.53 → winipedia_utils-0.6.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.4.53
+Version: 0.6.7
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -105,7 +105,7 @@ 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, all workfows run on the latest possible python version in pyproject.toml)
+- `.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
@@ -114,27 +114,60 @@ The setup creates the following configuration files:
 - `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.
+
+#### Workflow Structure
+
+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 script src/artifacts/build.py exists. This script is created by the setup command and can be modified to create build artifacts for your project. This script then just needs to create artifacts in a folder called artifacts and those will be uploaded as artifacts to the release.
+
 ### Pre-commit Hook Workflow
 
 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.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
 
@@ -203,8 +236,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

{winipedia_utils-0.4.53 → winipedia_utils-0.6.7}/README.md

@@ -78,7 +78,7 @@ 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, all workfows run on the latest possible python version in pyproject.toml)
+- `.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
@@ -87,27 +87,60 @@ The setup creates the following configuration files:
 - `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.
+
+#### Workflow Structure
+
+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 script src/artifacts/build.py exists. This script is created by the setup command and can be modified to create build artifacts for your project. This script then just needs to create artifacts in a folder called artifacts and those will be uploaded as artifacts to the release.
+
 ### Pre-commit Hook Workflow
 
 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.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
 
@@ -176,8 +209,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

{winipedia_utils-0.4.53 → winipedia_utils-0.6.7}/pyproject.toml

@@ -1,17 +1,17 @@
 # Project section
 [project]
 name = "winipedia-utils"
-version = "0.4.53"
+version = "0.6.7"
 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"
+dependencies = ["polars", "pyyaml", "keyring", "pygithub", "pathspec", "networkx", "setuptools", "tqdm", "defusedxml", "cryptography", "tomlkit", "dotenv"]
 
-# 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"
@@ -20,20 +20,6 @@ build-backend = "poetry.core.masonry.api"
 [[tool.poetry.packages]]
 include = "winipedia_utils"
 
-[tool.poetry.dependencies]
-tqdm = "*"
-setuptools = "*"
-defusedxml = "*"
-tomlkit = "*"
-pathspec = "*"
-pyyaml = "*"
-keyring = "*"
-cryptography = "*"
-polars = "*"
-pygithub = "*"
-dotenv = "*"
-networkx = "*"
-
 [tool.poetry.group.dev.dependencies]
 ruff = "*"
 pre-commit = "*"

winipedia_utils-0.6.7/winipedia_utils/artifacts/build.py

@@ -0,0 +1,78 @@
+"""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 pathlib import Path
+
+from winipedia_utils.git.github.workflows.base.base import Workflow
+from winipedia_utils.oop.mixins.mixin import ABCLoggingMixin
+
+
+class Build(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_PATH = Workflow.ARTIFACTS_PATH
+
+    @classmethod
+    @abstractmethod
+    def get_artifacts(cls) -> list[Path]:
+        """Build the project.
+
+        Returns:
+            list[Path]: List of paths to the built artifacts
+        """
+
+    @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)
+        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)
+
+
+class WinipediaUtilsBuild(Build):
+    """Build script for winipedia_utils."""
+
+    @classmethod
+    def get_artifacts(cls) -> list[Path]:
+        """Build the project."""
+        paths = [cls.ARTIFACTS_PATH / "build.txt"]
+        for path in paths:
+            path.write_text("Hello World!")
+        return paths
+
+
+if __name__ == "__main__":
+    WinipediaUtilsBuild()