winipedia-utils 0.2.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

winipedia_utils/resources/svgs/play_icon.svg

@@ -1,17 +1,17 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools -->
-<svg width="800px" height="800px" viewBox="-3 0 28 28" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:sketch="http://www.bohemiancoding.com/sketch/ns">
-    
-    <title>play</title>
-    <desc>Created with Sketch Beta.</desc>
-    <defs>
-
-</defs>
-    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd" sketch:type="MSPage">
-        <g id="Icon-Set-Filled" sketch:type="MSLayerGroup" transform="translate(-419.000000, -571.000000)" fill="#000000">
-            <path d="M440.415,583.554 L421.418,571.311 C420.291,570.704 419,570.767 419,572.946 L419,597.054 C419,599.046 420.385,599.36 421.418,598.689 L440.415,586.446 C441.197,585.647 441.197,584.353 440.415,583.554" id="play" sketch:type="MSShapeGroup">
-
-</path>
-        </g>
-    </g>
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools -->
+<svg width="800px" height="800px" viewBox="-3 0 28 28" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:sketch="http://www.bohemiancoding.com/sketch/ns">
+    
+    <title>play</title>
+    <desc>Created with Sketch Beta.</desc>
+    <defs>
+
+</defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd" sketch:type="MSPage">
+        <g id="Icon-Set-Filled" sketch:type="MSLayerGroup" transform="translate(-419.000000, -571.000000)" fill="#000000">
+            <path d="M440.415,583.554 L421.418,571.311 C420.291,570.704 419,570.767 419,572.946 L419,597.054 C419,599.046 420.385,599.36 421.418,598.689 L440.415,586.446 C441.197,585.647 441.197,584.353 440.415,583.554" id="play" sketch:type="MSShapeGroup">
+
+</path>
+        </g>
+    </g>
 </svg>

winipedia_utils/resources/svgs/plus_icon.svg

@@ -1,24 +1,24 @@
-<?xml version="1.0" ?>
-
-<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools -->
-<svg width="800px" height="800px" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
-
-<title/>
-
-<g id="Complete">
-
-<g data-name="add" id="add-2">
-
-<g>
-
-<line fill="none" stroke="#000000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" x1="12" x2="12" y1="19" y2="5"/>
-
-<line fill="none" stroke="#000000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" x1="5" x2="19" y1="12" y2="12"/>
-
-</g>
-
-</g>
-
-</g>
-
+<?xml version="1.0" ?>
+
+<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools -->
+<svg width="800px" height="800px" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+
+<title/>
+
+<g id="Complete">
+
+<g data-name="add" id="add-2">
+
+<g>
+
+<line fill="none" stroke="#000000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" x1="12" x2="12" y1="19" y2="5"/>
+
+<line fill="none" stroke="#000000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" x1="5" x2="19" y1="12" y2="12"/>
+
+</g>
+
+</g>
+
+</g>
+
 </svg>

winipedia_utils/resources/svgs/svg.py

@@ -1,15 +1,15 @@
-"""utils for svgs."""
-
-from importlib.resources import as_file, files
-from pathlib import Path
-from types import ModuleType
-
-from winipedia_utils.resources import svgs
-
-
-def get_svg_path(svg_name: str, package: ModuleType | None = None) -> Path:
-    """Get the path to a svg."""
-    package = package or svgs
-    svg_path = files(package) / f"{svg_name}.svg"
-    with as_file(svg_path) as path:
-        return path
+"""utils for svgs."""
+
+from importlib.resources import as_file, files
+from pathlib import Path
+from types import ModuleType
+
+from winipedia_utils.resources import svgs
+
+
+def get_svg_path(svg_name: str, package: ModuleType | None = None) -> Path:
+    """Get the path to a svg."""
+    package = package or svgs
+    svg_path = files(package) / f"{svg_name}.svg"
+    with as_file(svg_path) as path:
+        return path

winipedia_utils/security/__init__.py

@@ -1 +1 @@
-"""__init__ module for winipedia_utils.security."""
+"""__init__ module for winipedia_utils.security."""

winipedia_utils/security/cryptography.py

@@ -1,29 +1,29 @@
-"""Cryptography utilities for secure data handling.
-
-This module provides utility functions for working with cryptography,
-including encryption and decryption using Fernet and AESGCM.
-These utilities help with secure data handling.
-"""
-
-import os
-
-from cryptography.hazmat.primitives.ciphers.aead import AESGCM
-
-IV_LEN = 12
-
-
-def encrypt_with_aes_gcm(
-    aes_gcm: AESGCM, data: bytes, aad: bytes | None = None
-) -> bytes:
-    """Encrypt data using AESGCM."""
-    iv = os.urandom(IV_LEN)
-    encrypted = aes_gcm.encrypt(iv, data, aad)
-    return iv + encrypted
-
-
-def decrypt_with_aes_gcm(
-    aes_gcm: AESGCM, data: bytes, aad: bytes | None = None
-) -> bytes:
-    """Decrypt data using AESGCM."""
-    iv, encrypted = data[:IV_LEN], data[IV_LEN:]
-    return aes_gcm.decrypt(iv, encrypted, aad)
+"""Cryptography utilities for secure data handling.
+
+This module provides utility functions for working with cryptography,
+including encryption and decryption using Fernet and AESGCM.
+These utilities help with secure data handling.
+"""
+
+import os
+
+from cryptography.hazmat.primitives.ciphers.aead import AESGCM
+
+IV_LEN = 12
+
+
+def encrypt_with_aes_gcm(
+    aes_gcm: AESGCM, data: bytes, aad: bytes | None = None
+) -> bytes:
+    """Encrypt data using AESGCM."""
+    iv = os.urandom(IV_LEN)
+    encrypted = aes_gcm.encrypt(iv, data, aad)
+    return iv + encrypted
+
+
+def decrypt_with_aes_gcm(
+    aes_gcm: AESGCM, data: bytes, aad: bytes | None = None
+) -> bytes:
+    """Decrypt data using AESGCM."""
+    iv, encrypted = data[:IV_LEN], data[IV_LEN:]
+    return aes_gcm.decrypt(iv, encrypted, aad)

winipedia_utils/security/keyring.py

@@ -1,70 +1,70 @@
-"""Keyring utilities for secure storage and retrieval of secrets.
-
-This module provides utility functions for working with keyring,
-including getting and creating secrets and fernets.
-These utilities help with secure storage and retrieval of secrets.
-"""
-
-from base64 import b64decode, b64encode
-from collections.abc import Callable
-
-import keyring
-from cryptography.fernet import Fernet
-from cryptography.hazmat.primitives.ciphers.aead import AESGCM
-
-
-def get_or_create_fernet(service_name: str, username: str) -> tuple[Fernet, bytes]:
-    """Get the app secret using keyring.
-
-    If it does not exist, create it with a Fernet.
-    """
-    return get_or_create_key(
-        service_name, username, Fernet, lambda: Fernet.generate_key()
-    )
-
-
-def get_or_create_aes_gcm(service_name: str, username: str) -> tuple[AESGCM, bytes]:
-    """Get the app secret using keyring.
-
-    If it does not exist, create it with a AESGCM.
-    """
-    return get_or_create_key(
-        service_name, username, AESGCM, lambda: AESGCM.generate_key(bit_length=256)
-    )
-
-
-def get_or_create_key[T](
-    service_name: str,
-    username: str,
-    key_class: Callable[[bytes], T],
-    generate_key_func: Callable[..., bytes],
-) -> tuple[T, bytes]:
-    """Get the app secret using keyring.
-
-    If it does not exist, create it with the generate_func.
-    """
-    key = get_key_as_str(service_name, username, key_class)
-    if key is None:
-        binary_key = generate_key_func()
-        key = b64encode(binary_key).decode("ascii")
-        modified_service_name = make_service_name(service_name, key_class)
-        keyring.set_password(modified_service_name, username, key)
-
-    binary_key = b64decode(key)
-    return key_class(binary_key), binary_key
-
-
-def get_key_as_str[T](
-    service_name: str, username: str, key_class: Callable[[bytes], T]
-) -> str | None:
-    """Get the app secret using keyring.
-
-    If it does not exist, create it with the generate_func.
-    """
-    service_name = make_service_name(service_name, key_class)
-    return keyring.get_password(service_name, username)
-
-
-def make_service_name[T](service_name: str, key_class: Callable[[bytes], T]) -> str:
-    """Make a service name from a service name and a key class."""
-    return f"{service_name}_{key_class.__name__}"
+"""Keyring utilities for secure storage and retrieval of secrets.
+
+This module provides utility functions for working with keyring,
+including getting and creating secrets and fernets.
+These utilities help with secure storage and retrieval of secrets.
+"""
+
+from base64 import b64decode, b64encode
+from collections.abc import Callable
+
+import keyring
+from cryptography.fernet import Fernet
+from cryptography.hazmat.primitives.ciphers.aead import AESGCM
+
+
+def get_or_create_fernet(service_name: str, username: str) -> tuple[Fernet, bytes]:
+    """Get the app secret using keyring.
+
+    If it does not exist, create it with a Fernet.
+    """
+    return get_or_create_key(
+        service_name, username, Fernet, lambda: Fernet.generate_key()
+    )
+
+
+def get_or_create_aes_gcm(service_name: str, username: str) -> tuple[AESGCM, bytes]:
+    """Get the app secret using keyring.
+
+    If it does not exist, create it with a AESGCM.
+    """
+    return get_or_create_key(
+        service_name, username, AESGCM, lambda: AESGCM.generate_key(bit_length=256)
+    )
+
+
+def get_or_create_key[T](
+    service_name: str,
+    username: str,
+    key_class: Callable[[bytes], T],
+    generate_key_func: Callable[..., bytes],
+) -> tuple[T, bytes]:
+    """Get the app secret using keyring.
+
+    If it does not exist, create it with the generate_func.
+    """
+    key = get_key_as_str(service_name, username, key_class)
+    if key is None:
+        binary_key = generate_key_func()
+        key = b64encode(binary_key).decode("ascii")
+        modified_service_name = make_service_name(service_name, key_class)
+        keyring.set_password(modified_service_name, username, key)
+
+    binary_key = b64decode(key)
+    return key_class(binary_key), binary_key
+
+
+def get_key_as_str[T](
+    service_name: str, username: str, key_class: Callable[[bytes], T]
+) -> str | None:
+    """Get the app secret using keyring.
+
+    If it does not exist, create it with the generate_func.
+    """
+    service_name = make_service_name(service_name, key_class)
+    return keyring.get_password(service_name, username)
+
+
+def make_service_name[T](service_name: str, key_class: Callable[[bytes], T]) -> str:
+    """Make a service name from a service name and a key class."""
+    return f"{service_name}_{key_class.__name__}"

winipedia_utils/setup.py

@@ -1,47 +1,47 @@
-"""A script that can be called after you installed the package.
-
-This script calls create tests, creates the pre-commit config, and
-creates the pyproject.toml file and some other things to set up a project.
-This package assumes you are using poetry and pre-commit.
-This script is intended to be called once at the beginning of a project.
-"""
-
-from winipedia_utils.git.gitignore.gitignore import _add_package_patterns_to_gitignore
-from winipedia_utils.git.pre_commit.config import (
-    _add_package_hook_to_pre_commit_config,
-    _pre_commit_install,
-)
-from winipedia_utils.git.pre_commit.run_hooks import _run_all_hooks
-from winipedia_utils.logging.logger import get_logger
-from winipedia_utils.projects.poetry.config import (
-    _add_configurations_to_pyproject_toml,
-)
-from winipedia_utils.projects.poetry.poetry import (
-    _install_dev_dependencies,
-)
-from winipedia_utils.projects.project import _create_project_root
-
-logger = get_logger(__name__)
-
-
-def _setup() -> None:
-    """Set up the project."""
-    # install winipedia_utils dev dependencies as dev
-    _install_dev_dependencies()
-    # create pre-commit config
-    _add_package_hook_to_pre_commit_config()
-    # install pre-commit
-    _pre_commit_install()
-    # add patterns to .gitignore
-    _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!")
-
-
-if __name__ == "__main__":
-    _setup()
+"""A script that can be called after you installed the package.
+
+This script calls create tests, creates the pre-commit config, and
+creates the pyproject.toml file and some other things to set up a project.
+This package assumes you are using poetry and pre-commit.
+This script is intended to be called once at the beginning of a project.
+"""
+
+from winipedia_utils.git.gitignore.gitignore import _add_package_patterns_to_gitignore
+from winipedia_utils.git.pre_commit.config import (
+    _add_package_hook_to_pre_commit_config,
+    _pre_commit_install,
+)
+from winipedia_utils.git.pre_commit.run_hooks import _run_all_hooks
+from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.projects.poetry.config import (
+    _add_configurations_to_pyproject_toml,
+)
+from winipedia_utils.projects.poetry.poetry import (
+    _install_dev_dependencies,
+)
+from winipedia_utils.projects.project import _create_project_root
+
+logger = get_logger(__name__)
+
+
+def _setup() -> None:
+    """Set up the project."""
+    # install winipedia_utils dev dependencies as dev
+    _install_dev_dependencies()
+    # create pre-commit config
+    _add_package_hook_to_pre_commit_config()
+    # install pre-commit
+    _pre_commit_install()
+    # add patterns to .gitignore
+    _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!")
+
+
+if __name__ == "__main__":
+    _setup()

winipedia_utils/testing/assertions.py

@@ -1,23 +1,23 @@
-"""Testing assertion utilities for enhanced test validation.
-
-This module provides custom assertion functions that extend Python's built-in
-assert statement with additional features like improved error messages and
-specialized validation logic for common testing scenarios.
-"""
-
-
-def assert_with_msg(expr: bool, msg: str) -> None:  # noqa: FBT001
-    """Assert that an expression is true with a custom error message.
-
-    A thin wrapper around Python's built-in assert statement that makes it
-    easier to provide meaningful error messages when assertions fail.
-
-    Args:
-        expr: The expression to evaluate for truthiness
-        msg: The error message to display if the assertion fails
-
-    Raises:
-        AssertionError: If the expression evaluates to False
-
-    """
-    assert expr, msg  # noqa: S101  # nosec: B101
+"""Testing assertion utilities for enhanced test validation.
+
+This module provides custom assertion functions that extend Python's built-in
+assert statement with additional features like improved error messages and
+specialized validation logic for common testing scenarios.
+"""
+
+
+def assert_with_msg(expr: bool, msg: str) -> None:  # noqa: FBT001
+    """Assert that an expression is true with a custom error message.
+
+    A thin wrapper around Python's built-in assert statement that makes it
+    easier to provide meaningful error messages when assertions fail.
+
+    Args:
+        expr: The expression to evaluate for truthiness
+        msg: The error message to display if the assertion fails
+
+    Raises:
+        AssertionError: If the expression evaluates to False
+
+    """
+    assert expr, msg  # noqa: S101  # nosec: B101