winipedia-utils 0.5.22__py3-none-any.whl → 0.7.1__py3-none-any.whl

{winipedia_utils-0.5.22.dist-info → winipedia_utils-0.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.5.22
+Version: 0.7.1
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -136,7 +136,7 @@ The health check workflow consists of two jobs:
    - Add Poetry to PATH (Windows-specific step)
    - Install dependencies
    - Setup CI keyring
-   - Protect repository (applies branch protection rules)
+   - 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:
@@ -145,6 +145,7 @@ The health check workflow consists of two jobs:
    - 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
 
@@ -152,21 +153,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
 
@@ -202,7 +203,7 @@ Configuration files are managed automatically by the setup system:
 
 ## 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
 
@@ -248,8 +249,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
@@ -257,7 +258,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
 ```
 
@@ -266,7 +267,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")
@@ -284,7 +285,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
@@ -292,7 +293,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
 )
@@ -303,8 +304,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
@@ -334,10 +335,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
@@ -345,7 +346,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
@@ -353,7 +354,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
@@ -361,7 +362,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.7.1.dist-info/RECORD

@@ -0,0 +1,109 @@
+winipedia_utils/__init__.py,sha256=vOWZ8n-YemVIzDLd8eWw1HVPGH3jxuT6VtDKHbmxk_A,43
+winipedia_utils/artifacts/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/artifacts/build.py,sha256=idKMw124cO5M8080AujxGzhYbVTQGIETkf-UxCEh8oY,767
+winipedia_utils/dev/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/artifacts/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/artifacts/build.py,sha256=DZrhVcmHt3J0kbkn8r4ZQNPXviQGcJIhYPozophs5kA,2064
+winipedia_utils/dev/configs/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/configs/base/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/configs/base/config.py,sha256=nNtZnsUYBhgppMt8CmxDDmBggFynxaaeEfa1JRJcWPY,7838
+winipedia_utils/dev/configs/gitignore.py,sha256=VYapZJl_K0ss-XIQltjGY6shAp0By_B9QvYQlSk0MVo,2612
+winipedia_utils/dev/configs/pre_commit.py,sha256=ICRAxfHOuFpd6HE9NgziCAj22LNO89JdyOddueE6cTo,1868
+winipedia_utils/dev/configs/pyproject.py,sha256=GpBdNSHVqhw2kpFQibf6NyDlH1-jv-9bNvK0FcQ9aBU,11102
+winipedia_utils/dev/configs/testing.py,sha256=aThPo3fphhzHl6c6Ujvf6AvLAj85jWuhjpDywTgqkUQ,3668
+winipedia_utils/dev/configs/workflows/__init__.py,sha256=BPdntTwFEyBMJ6MyT7gddPHswvRdH9tsRtfK72VSV7Y,57
+winipedia_utils/dev/configs/workflows/base/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/configs/workflows/base/base.py,sha256=3dO25DiPcPUHYj_Ha9a6s4_1DD67bb-R9brU3a9-bC0,28775
+winipedia_utils/dev/configs/workflows/health_check.py,sha256=KChweSxamAjgy1uOrRcpIQ5wdn4JzrRhT8x28XhVTXk,2168
+winipedia_utils/dev/configs/workflows/publish.py,sha256=SPrG2E8MERtcgNd9x6adM9Rsvks9zWq-CwzcuJMYEgE,1472
+winipedia_utils/dev/configs/workflows/release.py,sha256=zZr4AHMOaexxZgbS5gdXexK10WcZmUGh_cJG5riMlKo,2923
+winipedia_utils/dev/git/__init__.py,sha256=IRmEVz0sUEw47Eli--57YaypWitxlcYThT_ulwkhNTE,47
+winipedia_utils/dev/git/github/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/git/github/repo/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/git/github/repo/protect.py,sha256=HYB9cunOkGnqImIR9F0jQfBedkVtlHMaRgOwTqejrpM,3169
+winipedia_utils/dev/git/pre_commit/__init__.py,sha256=gFLVGQRmS6abgy5MfPQy_GZiF1_hGxuXtcOHX95WL-A,58
+winipedia_utils/dev/git/pre_commit/hooks.py,sha256=wwrzeugiwdKh-FIQ7iZWJSp9uqyj7Ec0kkZtVv7VO6U,2483
+winipedia_utils/dev/git/pre_commit/run_hooks.py,sha256=E2GiW88MYd3x4x6whYlmmb8zwoAdyFGmI4dg03LoDs4,1797
+winipedia_utils/dev/projects/__init__.py,sha256=_iYHzUcTPmutpsExPDcMF9OQDgnz-kTSuWens9iP9bI,52
+winipedia_utils/dev/projects/poetry/__init__.py,sha256=tbvV3wYd3H39hjjlKbF84Irj4hYgv1A7KWyXdCQzFro,59
+winipedia_utils/dev/projects/poetry/dev_deps.py,sha256=8QIunGKoqlNlq1Co5bT3UWzoxIiiEGpGP9si7xLI0P0,535
+winipedia_utils/dev/projects/poetry/poetry.py,sha256=Uhuk9nGNWjzv4gql3-dELcFC9Q3f54GH_kWSx0GltYE,8490
+winipedia_utils/dev/projects/project.py,sha256=jGzWNpJ4abMiKNlBLPlFS2TG7MQpd0ijYlmWzjll3k4,537
+winipedia_utils/dev/testing/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/testing/convention.py,sha256=YAozeOwrKlq6K6u30_bYXUFtxfFtGP0lf1SdbKrojqU,4839
+winipedia_utils/dev/testing/create_tests.py,sha256=msLIBh8o5W1EJWCOcYy7YLgg3iEs_g5YefAZJvzdY4I,9416
+winipedia_utils/dev/testing/tests/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/testing/tests/base/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/testing/tests/base/fixtures/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/testing/tests/base/fixtures/fixture.py,sha256=7R4Az6kRiL8sEowenbS4QjvWvnWf9X_ZfxVqvJoMsbs,1220
+winipedia_utils/dev/testing/tests/base/fixtures/scopes/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/testing/tests/base/fixtures/scopes/class_.py,sha256=j9umMWRcFTTKZ5Dt40Cv4pxkxdSlalkDk-DvfHpDb7g,1092
+winipedia_utils/dev/testing/tests/base/fixtures/scopes/function.py,sha256=l1zCCiTkXUSZp0n9QOyejhfszFJiMH88bhGMwNY5r8A,302
+winipedia_utils/dev/testing/tests/base/fixtures/scopes/module.py,sha256=-Ugy1Jsao9Qkk2MHl-6dXHMKKE9hTgqHKgSUZcR1OmM,1228
+winipedia_utils/dev/testing/tests/base/fixtures/scopes/package.py,sha256=pR3so6QPymIRM4PJTODrlBKI-yQnZ2P78BsiyTPaF8o,302
+winipedia_utils/dev/testing/tests/base/fixtures/scopes/session.py,sha256=GpDyhXdroGGYTNX6EgapxKJIc_h0gw6CuKgtA7YpgFI,6141
+winipedia_utils/dev/testing/tests/base/utils/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/dev/testing/tests/base/utils/utils.py,sha256=yF8K6oliUsyLmr0lfq-QYIpNy2uWYbQhTK59zJoo0sE,25
+winipedia_utils/dev/testing/tests/conftest.py,sha256=zHeokbp6R2iAn2bmm5BDXqyR9Mtf7QE0evZycTBf_vE,898
+winipedia_utils/dev/testing/utils.py,sha256=ZJeY7_PdoirU0bkSQ-bqByYBYD8ElhBubdMfI2dnYeM,2207
+winipedia_utils/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+winipedia_utils/setup.py,sha256=K91g_pK5ezkGMwqnl3rAaeF8PFbgZa2ury53e0tzRM0,1486
+winipedia_utils/utils/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/utils/data/__init__.py,sha256=o6SXX1gBCwhb9abo8xTfZtqUNuLqXmdo2VervnJxRzc,48
+winipedia_utils/utils/data/dataframe/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/utils/data/dataframe/cleaning.py,sha256=w6N0los24ZfsEQB2FDAzhVpjR8TJeJlt_VBfROmpPuw,23438
+winipedia_utils/utils/data/structures/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/utils/data/structures/dicts.py,sha256=jsFzQ96cvyHsvPSnsEUhksuWvLSGq6-Rryfw6gEXq-c,274
+winipedia_utils/utils/data/structures/text/__init__.py,sha256=j2bwtK6kyeHI6SnoBjpRju0C1W2n2paXBDlNjNtaUxA,48
+winipedia_utils/utils/data/structures/text/string.py,sha256=Sq7aQ6YMB6sVBsYQYZ2P9d8uEe9zIvi8aUMYjyRQOwk,4453
+winipedia_utils/utils/git/__init__.py,sha256=IRmEVz0sUEw47Eli--57YaypWitxlcYThT_ulwkhNTE,47
+winipedia_utils/utils/git/github/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/utils/git/github/github.py,sha256=FzmvxGOny0oPp-pV0SiZRSMC2HHE0SuA5ak8QFZwt-M,826
+winipedia_utils/utils/git/github/repo/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/utils/git/github/repo/repo.py,sha256=85LXlADugpvRY-KHbSdd2z5upLFnMakOHmi3ZFy5J3M,7871
+winipedia_utils/utils/git/gitignore/__init__.py,sha256=k-2E26JaZPkF69UUOJkpQl8T_PudrC7EYCIOxwgIQVU,57
+winipedia_utils/utils/git/gitignore/gitignore.py,sha256=1lNqG9EFFz2b0tWqcO__Go3_3vhw9yeNqg35ATPYdCU,2426
+winipedia_utils/utils/iterating/__init__.py,sha256=rlF9hzxbowq5yOfcXvOKOQdB-EQmfrislQpf659Zeu4,53
+winipedia_utils/utils/iterating/concurrent/__init__.py,sha256=Tu0ig4gVCk_f1n74G35hDwH-WS3P3STVQGWjxTIbbo8,54
+winipedia_utils/utils/iterating/concurrent/concurrent.py,sha256=z0mezS9uvmi5cKdNFud46Ts52U__8hhXObJL0wsGuGg,8692
+winipedia_utils/utils/iterating/concurrent/multiprocessing.py,sha256=8W-dJ6z12z1grxgQH53Dk87N0yse5EYKWUniyVMUkW8,4743
+winipedia_utils/utils/iterating/concurrent/multithreading.py,sha256=4lBuZQUxep-1omnB4Gf-5xXwoBbNwsq52-sNoI8qZ4U,3096
+winipedia_utils/utils/iterating/iterate.py,sha256=k4U6qrnE4zij-GJhI5X0wM3pveSi8wtEsA1i8xQrfG0,3522
+winipedia_utils/utils/logging/__init__.py,sha256=AMt1LwA_E7hexYjMpGzUempoyDdAF-dowWvq59wC5aM,51
+winipedia_utils/utils/logging/ansi.py,sha256=7Z-FITaUn5B1ZE0OUVARjNzuMui1V36iu4YTjlD6QfI,101
+winipedia_utils/utils/logging/config.py,sha256=sdC3GHMkJqlY-WwIsOMeTcy1bihthWV2LbvxLt9dhc4,2895
+winipedia_utils/utils/logging/logger.py,sha256=IZDNiDBWVauA7UsZj5HXnCLMzBQM2zN9YDWhCHg0DbM,707
+winipedia_utils/utils/modules/__init__.py,sha256=e3CFaC3FhK4ibknFOv1bqOZxA7XeVwmLqWX7oajUm78,51
+winipedia_utils/utils/modules/class_.py,sha256=iEtrvbGju1LVlTGP3fUmF5kajW0FDsk9ZSHeM4ns0EI,5685
+winipedia_utils/utils/modules/function.py,sha256=0QtHtfAjKal3GRRU9CP4LfHgoIHpbU88AgTZ2fv6v9k,3491
+winipedia_utils/utils/modules/inspection.py,sha256=XPSJfLN6WnNmbXn-6z9D01cmqmPS-HrTPy6-B6C34tw,1821
+winipedia_utils/utils/modules/module.py,sha256=kMV1wH8S2incHUlMKgP5CmIJXjYXaka_s_e_M5XyV7M,12835
+winipedia_utils/utils/modules/package.py,sha256=zlobKYKqMBYcQsqGCc0v0DeLpLUQTDDayi-fm3bduek,17295
+winipedia_utils/utils/oop/__init__.py,sha256=wGjsVwLbTVEQWOfDJvN9nlvC-3NmAi8Doc2xIrm6e78,47
+winipedia_utils/utils/oop/mixins/__init__.py,sha256=PDK-cJcdRUfDUCz36qQ5pmMW07G133WtN49OpmILGNI,54
+winipedia_utils/utils/oop/mixins/meta.py,sha256=fnH2jVXWMIObdb2PQH0p0-j1kfFdEeD2_QWvWM2UivY,11190
+winipedia_utils/utils/oop/mixins/mixin.py,sha256=h1Fc5ZhESFv7g9dhpSWcMN1B6VPh2BHjPwWmzM9Tomc,1413
+winipedia_utils/utils/os/__init__.py,sha256=cBRq8hWhaWvYeC3cSBYL6Y70kM9COQWHj8vVxxSadIg,46
+winipedia_utils/utils/os/os.py,sha256=giBJDrWewOtxoSExNj6y_afOcxhpDAVGs2W93xUR96k,1777
+winipedia_utils/utils/resources/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/utils/resources/svgs/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/utils/resources/svgs/delete_garbage_can.svg,sha256=UxEEh46w1JD4VViUBx-Ahaq5_ZR4zOjfeJn5_aM8114,318
+winipedia_utils/utils/resources/svgs/download_arrow.svg,sha256=8g_cBwKFHyoeSmaLMXcGwIHT4_rZDDtDGm35E0PkniE,242
+winipedia_utils/utils/resources/svgs/exit_fullscreen_icon.svg,sha256=sZSexEjab82zhAK3JRtOWH19aAFa1GhuGLChDz9wFFc,523
+winipedia_utils/utils/resources/svgs/fullscreen_icon.svg,sha256=mm2n6WvaSu0OqiQSAw0QPNwzXpPLaF53_XAklUfQQPo,406
+winipedia_utils/utils/resources/svgs/menu_icon.svg,sha256=pA1Z_x5gDkhYLQA0dL0l_8uBP-e6mKLcEOYwlhURUv4,344
+winipedia_utils/utils/resources/svgs/pause_icon.svg,sha256=z-Cj3DOI0rwRbWCOhaiHtDQYM4s6OgkCBVcdip77rQE,179
+winipedia_utils/utils/resources/svgs/play_icon.svg,sha256=7gx1EWZnyu1pA6WboAfVH3OGcp_uYPpT1syqHe-jaGE,953
+winipedia_utils/utils/resources/svgs/plus_icon.svg,sha256=1ucedu8ucLI7LMNsfNN2GYiwNUe8-ViNBcanDwzTqHc,552
+winipedia_utils/utils/resources/svgs/svg.py,sha256=Mqvvwjk_64aHe9T9epZ1ulHt6grBWnZgK3bnPpSyldU,421
+winipedia_utils/utils/security/__init__.py,sha256=HmGXOCROqIGHlBs2bEWRMkEX3rlXNsnA9Tef58AlCo4,52
+winipedia_utils/utils/security/cryptography.py,sha256=5LMat3-9nDW2cQBr_dU7MFRdgbiK53zQqHyacs-Jq-s,793
+winipedia_utils/utils/security/keyring.py,sha256=6kKgSTz1G80F6XeZ3Lskxdl2N6JgUH8gJdFYcGJuysU,2273
+winipedia_utils/utils/testing/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/utils/testing/assertions.py,sha256=FYuDIeeQKCbaKFaGRnNWkxlJ-xNoPyxwCjq3vtM9Oz4,1914
+winipedia_utils/utils/testing/fixtures.py,sha256=G8QIrZXndtud0uOk6PY3f8IIDoyX_ronogjeLAYGjrM,1033
+winipedia_utils/utils/testing/skip.py,sha256=nxBNqysJaXaXaJOVb-J8K8OGCV0xP_YfgjO0pA3m9u4,492
+winipedia_utils-0.7.1.dist-info/METADATA,sha256=6jeyCPlh7JCi9ar2e_1KP-M2BCT3HieDy6vE3FRA57A,16647
+winipedia_utils-0.7.1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+winipedia_utils-0.7.1.dist-info/licenses/LICENSE,sha256=o316mE2gGzd__JT69p7S_zlOmKiHh8YjpImCCcWyTvM,1066
+winipedia_utils-0.7.1.dist-info/RECORD,,

winipedia_utils/git/github/workflows/base/base.py

@@ -1,377 +0,0 @@
-"""Contains base utilities for git workflows."""
-
-from abc import abstractmethod
-from pathlib import Path
-from typing import Any, ClassVar
-
-import winipedia_utils
-from winipedia_utils.modules.module import make_obj_importpath
-from winipedia_utils.modules.package import get_src_package
-from winipedia_utils.projects.poetry.config import PyprojectConfigFile
-from winipedia_utils.text.config import YamlConfigFile
-from winipedia_utils.text.string import split_on_uppercase
-
-
-class Workflow(YamlConfigFile):
-    """Base class for workflows."""
-
-    EMPTY_CONFIG: ClassVar[dict[str, Any]] = {
-        "on": {
-            "workflow_dispatch": {},
-        },
-        "jobs": {
-            "empty": {
-                "runs-on": "ubuntu-latest",
-                "steps": [
-                    {
-                        "name": "Empty Step",
-                        "run": "echo 'Empty Step'",
-                    }
-                ],
-            },
-        },
-    }
-
-    @classmethod
-    def is_correct(cls) -> bool:
-        """Check if the config is correct.
-
-        Needs some special handling since workflow files cannot be empty.
-        We need a workflow that will never trigger and even if doesnt do anything.
-        """
-        correct = super().is_correct()
-        if cls.get_path().read_text() == "":
-            # dump a dispatch in there for on and an empty job for jobs
-            cls.dump(cls.EMPTY_CONFIG)
-
-        return correct or cls.load() == cls.EMPTY_CONFIG
-
-    @classmethod
-    @abstractmethod
-    def get_workflow_triggers(cls) -> dict[str, Any]:
-        """Get the workflow triggers."""
-
-    @classmethod
-    @abstractmethod
-    def get_permissions(cls) -> dict[str, Any]:
-        """Get the workflow permissions."""
-
-    @classmethod
-    @abstractmethod
-    def get_jobs(cls) -> dict[str, Any]:
-        """Get the workflow jobs."""
-
-    @classmethod
-    def get_parent_path(cls) -> Path:
-        """Get the path to the config file."""
-        return Path(".github/workflows")
-
-    @classmethod
-    def get_configs(cls) -> dict[str, Any]:
-        """Get the workflow config."""
-        return {
-            "name": cls.get_workflow_name(),
-            "on": cls.get_workflow_triggers(),
-            "permissions": cls.get_permissions(),
-            "run-name": cls.get_run_name(),
-            "defaults": {"run": {"shell": "bash"}},
-            "jobs": cls.get_jobs(),
-        }
-
-    @classmethod
-    def get_standard_job(  # noqa: PLR0913
-        cls,
-        name: str | None = None,
-        runs_on: str = "ubuntu-latest",
-        strategy: dict[str, Any] | None = None,
-        permissions: dict[str, Any] | None = None,
-        if_condition: str | None = None,
-        steps: list[dict[str, Any]] | None = None,
-        needs: list[str] | None = None,
-    ) -> dict[str, Any]:
-        """Get a standard job."""
-        job: dict[str, Any] = {}
-        if name is None:
-            name = cls.get_filename()
-        job[name] = {}
-        job_config = job[name]
-
-        if permissions is not None:
-            job_config["permissions"] = permissions
-
-        if strategy is not None:
-            job_config["strategy"] = strategy
-
-        job_config["runs-on"] = runs_on
-
-        if needs is not None:
-            job_config["needs"] = needs
-
-        if if_condition is not None:
-            job_config["if"] = if_condition
-
-        if steps is None:
-            steps = []
-        job_config["steps"] = steps
-
-        return job
-
-    @classmethod
-    def get_workflow_name(cls) -> str:
-        """Get the workflow name."""
-        return " ".join(split_on_uppercase(cls.__name__))
-
-    @classmethod
-    def get_run_name(cls) -> str:
-        """Get the workflow run name."""
-        return f"{cls.get_workflow_name()}"
-
-    @classmethod
-    def get_checkout_step(
-        cls,
-        fetch_depth: int | None = None,
-        *,
-        token: bool = False,
-    ) -> dict[str, Any]:
-        """Get the checkout step.
-
-        Args:
-        fetch_depth: The fetch depth to use. If None, no fetch depth is specified.
-        token: Whether to use the repository token.
-
-        Returns:
-        The checkout step.
-        """
-        step: dict[str, Any] = {
-            "name": "Checkout repository",
-            "uses": "actions/checkout@main",
-        }
-        if fetch_depth is not None:
-            step.setdefault("with", {})["fetch-depth"] = fetch_depth
-
-        if token:
-            step.setdefault("with", {})["token"] = cls.get_repo_token()
-        return step
-
-    @classmethod
-    def get_poetry_setup_steps(  # noqa: PLR0913
-        cls,
-        *,
-        install_dependencies: bool = False,
-        fetch_depth: int | None = None,
-        configure_pipy_token: bool = False,
-        force_main_head: bool = False,
-        repo_token: bool = False,
-        with_keyring: bool = False,
-        strategy_matrix: bool = False,
-    ) -> list[dict[str, Any]]:
-        """Get the poetry steps.
-
-        Args:
-        install_dependencies: Whether to install dependencies.
-        fetch_depth: The fetch depth to use. If None, no fetch depth is specified.
-        configure_pipy_token: Whether to configure the pipy token.
-        force_main_head: Whether to exit if the running branch or current commit is not
-            equal to the most recent commit on main. This is useful for workflows that
-            should only run on main.
-        repo_token: Whether to use the repository token.
-        with_keyring: Whether to setup the keyring.
-        strategy_matrix: Whether to use the strategy matrix python-version.
-            This is useful for jobs that use a matrix.
-
-        Returns:
-        The poetry steps.
-        """
-        steps = [cls.get_checkout_step(fetch_depth, token=repo_token)]
-        if force_main_head:
-            # exit with code 1 if the running branch is not main
-            steps.append(
-                {
-                    "name": "Assert running on head of main",
-                    "run": 'git fetch origin main --depth=1; main_sha=$(git rev-parse origin/main); if [ "$GITHUB_SHA" != "$main_sha" ]; then echo "Tag commit is not the latest commit on main."; exit 1; fi',  # noqa: E501
-                }
-            )
-        steps.append(cls.get_setup_git_step())
-        steps.append(
-            {
-                "name": "Setup Python",
-                "uses": "actions/setup-python@main",
-                "with": {
-                    # get latest if strategy matrix python-version is not set
-                    "python-version": "${{ matrix.python-version }}"
-                    if strategy_matrix
-                    else str(PyprojectConfigFile.get_latest_possible_python_version())
-                },
-            }
-        )
-        steps.append(
-            {
-                "name": "Setup Poetry",
-                "uses": "snok/install-poetry@main",
-            }
-        )
-
-        if strategy_matrix:
-            steps.append(
-                {
-                    # windows needs this step to find poetry
-                    "name": "Add Poetry to PATH",
-                    "run": "echo 'C:/Users/runneradmin/.local/bin' >> $GITHUB_PATH",
-                }
-            )
-
-        if configure_pipy_token:
-            steps.append(
-                {
-                    "name": "Configure Poetry with PyPI Token",
-                    "run": "poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}",
-                }
-            )
-
-        if install_dependencies:
-            steps.append({"name": "Install Dependencies", "run": "poetry install"})
-
-        if with_keyring:
-            steps.append(cls.get_setup_keyring_step())
-
-        return steps
-
-    @classmethod
-    def get_release_steps(cls) -> list[dict[str, Any]]:
-        """Get the release steps."""
-        return [
-            *cls.get_poetry_setup_steps(
-                install_dependencies=True,
-                repo_token=True,
-                with_keyring=True,
-            ),
-            cls.get_pre_commit_step(),
-            cls.get_commit_step(),
-            cls.get_extract_version_step(),
-            {
-                "name": "Tag and Push",
-                "run": f"git push && git tag {cls.get_version()} && git push origin {cls.get_version()}",  # noqa: E501
-            },
-            {
-                "name": "Build Changelog",
-                "id": "build_changelog",
-                "uses": "mikepenz/release-changelog-builder-action@develop",
-                "with": {"token": cls.get_github_token()},
-            },
-            {
-                "name": "Create GitHub Release",
-                "uses": "ncipollo/release-action@main",
-                "with": {
-                    "tag": cls.get_version(),
-                    "name": cls.get_repo_and_version(),
-                    "body": "${{ steps.build_changelog.outputs.changelog }}",
-                },
-            },
-        ]
-
-    @classmethod
-    def get_extract_version_step(cls) -> dict[str, Any]:
-        """Get the extract version step."""
-        return {
-            "name": "Extract Version from pyproject.toml",
-            "id": "version",
-            "run": 'version=$(poetry version -s) && echo "Project version: $version" && echo "version=v$version" >> $GITHUB_OUTPUT',  # noqa: E501
-        }
-
-    @classmethod
-    def get_publish_to_pypi_step(cls) -> dict[str, Any]:
-        """Get the publish step."""
-        return {"name": "Build and publish to PyPI", "run": "poetry publish --build"}
-
-    @classmethod
-    def get_pre_commit_step(cls) -> dict[str, Any]:
-        """Get the pre-commit step.
-
-        using pre commit in case other hooks are added later
-        and bc it fails if files are changed,
-        setup script shouldnt change files
-        """
-        step: dict[str, Any] = {
-            "name": "Run Hooks",
-            # poetry run is necessary although the hook itself uses poetry run as well.
-            # not sure why, but on windows-latest the venv is not continued to the hooks
-            # and if you leave it here then pre-commit command is not found
-            "run": "poetry run pre-commit run --all-files --verbose",
-        }
-        if get_src_package() == winipedia_utils:
-            step["env"] = {"REPO_TOKEN": cls.get_repo_token()}
-        return step
-
-    @classmethod
-    def get_setup_git_step(cls) -> dict[str, Any]:
-        """Get the setup git step."""
-        return {
-            "name": "Setup Git",
-            "run": 'git config --global user.email "github-actions[bot]@users.noreply.github.com" && git config --global user.name "github-actions[bot]"',  # noqa: E501
-        }
-
-    @classmethod
-    def get_commit_step(cls) -> dict[str, Any]:
-        """Get the commit step."""
-        return {
-            "name": "Commit added changes",
-            "run": "git commit --no-verify -m '[skip ci] CI/CD: Committing possible added changes (e.g.: pyproject.toml and poetry.lock)'",  # noqa: E501
-        }
-
-    @classmethod
-    def get_setup_keyring_step(cls) -> dict[str, Any]:
-        """Get the setup keyring step."""
-        return {
-            "name": "Setup CI keyring",
-            "run": 'poetry run pip install keyrings.alt && poetry run python -c "import keyring; from keyrings.alt.file import PlaintextKeyring; keyring.set_keyring(PlaintextKeyring());"',  # noqa: E501
-        }
-
-    @classmethod
-    def get_protect_repository_step(cls) -> dict[str, Any]:
-        """Get the protect repository step."""
-        from winipedia_utils.git.github.repo import (  # noqa: PLC0415
-            protect,  # avoid circular import
-        )
-
-        return {
-            "name": "Protect Repository",
-            "run": f"poetry run python -m {make_obj_importpath(protect)}",
-            "env": {
-                "REPO_TOKEN": cls.get_repo_token(),
-            },
-        }
-
-    @classmethod
-    def get_repository_name(cls) -> str:
-        """Get the repository name."""
-        return "${{ github.event.repository.name }}"
-
-    @classmethod
-    def get_ref_name(cls) -> str:
-        """Get the ref name."""
-        return "${{ github.ref_name }}"
-
-    @classmethod
-    def get_version(cls) -> str:
-        """Get the version."""
-        return "${{ steps.version.outputs.version }}"
-
-    @classmethod
-    def get_repo_and_version(cls) -> str:
-        """Get the repository name and ref name."""
-        return f"{cls.get_repository_name()} {cls.get_version()}"
-
-    @classmethod
-    def get_ownwer(cls) -> str:
-        """Get the repository owner."""
-        return "${{ github.repository_owner }}"
-
-    @classmethod
-    def get_github_token(cls) -> str:
-        """Get the GitHub token."""
-        return "${{ secrets.GITHUB_TOKEN }}"
-
-    @classmethod
-    def get_repo_token(cls) -> str:
-        """Get the repository token."""
-        return "${{ secrets.REPO_TOKEN }}"