winipedia-utils 0.2.18__tar.gz → 0.2.25__tar.gz

{winipedia_utils-0.2.18 → winipedia_utils-0.2.25}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.2.18
+Version: 0.2.25
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -126,10 +126,17 @@ Adds tool configurations in pyproject.toml for e.g.:
 - **pytest** - Test discovery and execution
 - **bandit** - Security scanning
 
-### Step 6️⃣ - Create Project Root
+### Step 6️⃣ - Create GitHub Actions Workflow
+Sets up `.github/workflows/publish.yaml` for automated PyPI publishing:
+- Triggers on GitHub releases
+- Configures Poetry with PyPI token
+- Builds and publishes package automatically
+- If you do not want to publish to pypi, you can delete the file, tests will not fail bc of it and it won't be added again unless you run the setup script again or delete the .github folder/workflows folder.
+
+### Step 7️⃣ - Create Project Root
 Creates your project's root package directory with `py.typed` marker for type hint support.
 
-### Step 7️⃣ - Run Pre-commit Hook
+### Step 8️⃣ - Run Pre-commit Hook
 Executes the complete quality pipeline (see below).
 
 ---
@@ -284,9 +291,9 @@ print(data.df)  # Cleaned and validated dataframe
 
 ### 3. 🔧 Git Utilities
 
-Manage gitignore patterns and pre-commit configuration.
+Manage gitignore patterns, pre-commit configuration, and GitHub Actions workflows.
 
-**Use Cases:** Project setup, git workflow automation
+**Use Cases:** Project setup, git workflow automation, CI/CD pipeline setup
 
 ```python
 from winipedia_utils.git.gitignore.gitignore import (
@@ -294,6 +301,10 @@ from winipedia_utils.git.gitignore.gitignore import (
     walk_os_skipping_gitignore_patterns,
     add_patterns_to_gitignore
 )
+from winipedia_utils.git.workflows.publish import (
+    load_publish_workflow,
+    dump_publish_workflow
+)
 
 # Check if path is ignored
 if path_is_in_gitignore("dist/"):
@@ -305,12 +316,18 @@ for root, dirs, files in walk_os_skipping_gitignore_patterns("."):
 
 # Add patterns to gitignore
 add_patterns_to_gitignore(["*.log", "temp/"])
+
+# Load and modify publish workflow
+workflow = load_publish_workflow()
+print(f"Workflow name: {workflow.get('name')}")
 ```
 
 **Key Functions:**
 - `path_is_in_gitignore()` - Check if path matches gitignore patterns
 - `walk_os_skipping_gitignore_patterns()` - Directory traversal respecting gitignore
 - `add_patterns_to_gitignore()` - Add patterns to .gitignore file
+- `load_publish_workflow()` - Load GitHub Actions publish workflow
+- `dump_publish_workflow()` - Save GitHub Actions publish workflow
 - Pre-commit configuration management
 
 ---

{winipedia_utils-0.2.18 → winipedia_utils-0.2.25}/README.md

@@ -102,10 +102,17 @@ Adds tool configurations in pyproject.toml for e.g.:
 - **pytest** - Test discovery and execution
 - **bandit** - Security scanning
 
-### Step 6️⃣ - Create Project Root
+### Step 6️⃣ - Create GitHub Actions Workflow
+Sets up `.github/workflows/publish.yaml` for automated PyPI publishing:
+- Triggers on GitHub releases
+- Configures Poetry with PyPI token
+- Builds and publishes package automatically
+- If you do not want to publish to pypi, you can delete the file, tests will not fail bc of it and it won't be added again unless you run the setup script again or delete the .github folder/workflows folder.
+
+### Step 7️⃣ - Create Project Root
 Creates your project's root package directory with `py.typed` marker for type hint support.
 
-### Step 7️⃣ - Run Pre-commit Hook
+### Step 8️⃣ - Run Pre-commit Hook
 Executes the complete quality pipeline (see below).
 
 ---
@@ -260,9 +267,9 @@ print(data.df)  # Cleaned and validated dataframe
 
 ### 3. 🔧 Git Utilities
 
-Manage gitignore patterns and pre-commit configuration.
+Manage gitignore patterns, pre-commit configuration, and GitHub Actions workflows.
 
-**Use Cases:** Project setup, git workflow automation
+**Use Cases:** Project setup, git workflow automation, CI/CD pipeline setup
 
 ```python
 from winipedia_utils.git.gitignore.gitignore import (
@@ -270,6 +277,10 @@ from winipedia_utils.git.gitignore.gitignore import (
     walk_os_skipping_gitignore_patterns,
     add_patterns_to_gitignore
 )
+from winipedia_utils.git.workflows.publish import (
+    load_publish_workflow,
+    dump_publish_workflow
+)
 
 # Check if path is ignored
 if path_is_in_gitignore("dist/"):
@@ -281,12 +292,18 @@ for root, dirs, files in walk_os_skipping_gitignore_patterns("."):
 
 # Add patterns to gitignore
 add_patterns_to_gitignore(["*.log", "temp/"])
+
+# Load and modify publish workflow
+workflow = load_publish_workflow()
+print(f"Workflow name: {workflow.get('name')}")
 ```
 
 **Key Functions:**
 - `path_is_in_gitignore()` - Check if path matches gitignore patterns
 - `walk_os_skipping_gitignore_patterns()` - Directory traversal respecting gitignore
 - `add_patterns_to_gitignore()` - Add patterns to .gitignore file
+- `load_publish_workflow()` - Load GitHub Actions publish workflow
+- `dump_publish_workflow()` - Save GitHub Actions publish workflow
 - Pre-commit configuration management
 
 ---

{winipedia_utils-0.2.18 → winipedia_utils-0.2.25}/pyproject.toml

@@ -1,7 +1,7 @@
 # Project section
 [project]
 name = "winipedia-utils"
-version = "0.2.18"
+version = "0.2.25"
 description = "A package with many utility functions"
 readme = "README.md"
 requires-python = ">=3.12"

winipedia_utils-0.2.25/winipedia_utils/git/workflows/__init__.py

@@ -0,0 +1 @@
+"""__init__ module for winipedia_utils.git.workflows."""

winipedia_utils-0.2.25/winipedia_utils/git/workflows/publish.py

@@ -0,0 +1,76 @@
+"""Contains the publish workflow.
+
+This workflow is used to publish the package to PyPI with poetry.
+"""
+
+from pathlib import Path
+from typing import Any
+
+import yaml
+
+PUBLISH_WORKFLOW_PATH = Path(".github/workflows/publish.yaml")
+
+
+def load_publish_workflow() -> dict[str, Any]:
+    """Load the publish workflow."""
+    path = PUBLISH_WORKFLOW_PATH
+    if not path.exists():
+        path.parent.mkdir(parents=True, exist_ok=True)
+        path.touch()
+    return yaml.safe_load(path.read_text()) or {}
+
+
+def dump_publish_workflow(config: dict[str, Any]) -> None:
+    """Dump the publish workflow."""
+    path = PUBLISH_WORKFLOW_PATH
+    with path.open("w") as f:
+        yaml.safe_dump(config, f, sort_keys=False)
+
+
+def _get_publish_config() -> dict[str, Any]:
+    """Dict that represents the publish workflow yaml."""
+    return {
+        "name": "Publish to PyPI",
+        "on": {"release": {"types": ["published"]}},
+        "jobs": {
+            "publish": {
+                "runs-on": "ubuntu-latest",
+                "steps": [
+                    {"name": "Checkout repository", "uses": "actions/checkout@v4"},
+                    {
+                        "name": "Set up Python",
+                        "uses": "actions/setup-python@v5",
+                        "with": {"python-version": "3.x"},
+                    },
+                    {"name": "Install Poetry", "run": "pip install poetry"},
+                    {
+                        "name": "Configure Poetry",
+                        "run": "poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}",  # noqa: E501
+                    },
+                    {
+                        "name": "Build and publish to PyPI",
+                        "run": "poetry publish --build",
+                    },
+                ],
+            }
+        },
+    }
+
+
+def _publish_config_is_correct() -> bool:
+    """Check if the publish workflow is correct."""
+    config = load_publish_workflow()
+    return bool(config == _get_publish_config())
+
+
+def _add_publish_workflow() -> None:
+    """Add the publish workflow.
+
+    If you delete the .github/workflows/publish.yaml file, then the tests will not fail.
+    Not all projects need publishing to pypi. It is added on setup, but if you remove
+    the file, then the tests will not fail and the tests will assume you don't want it.
+    """
+    if _publish_config_is_correct():
+        return
+    config = _get_publish_config()
+    dump_publish_workflow(config)

{winipedia_utils-0.2.18 → winipedia_utils-0.2.25}/winipedia_utils/setup.py

@@ -6,12 +6,16 @@ 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 collections.abc import Callable
+from typing import Any
+
 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.git.workflows.publish import _add_publish_workflow
 from winipedia_utils.logging.logger import get_logger
 from winipedia_utils.projects.poetry.config import (
     _add_configurations_to_pyproject_toml,
@@ -24,22 +28,28 @@ from winipedia_utils.projects.project import _create_project_root
 logger = get_logger(__name__)
 
 
+SETUP_STEPS = [
+    _install_dev_dependencies,
+    _add_package_hook_to_pre_commit_config,
+    _pre_commit_install,
+    _add_package_patterns_to_gitignore,
+    _add_publish_workflow,
+    _add_configurations_to_pyproject_toml,
+    _create_project_root,
+    _run_all_hooks,
+]
+
+
+def _get_setup_steps() -> list[Callable[..., Any]]:
+    """Get the setup steps."""
+    return SETUP_STEPS
+
+
 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()
+    for step in _get_setup_steps():
+        logger.info("Running setup step: %s", step.__name__)
+        step()
     logger.info("Setup complete!")
 
 

{winipedia_utils-0.2.18 → winipedia_utils-0.2.25}/winipedia_utils/testing/tests/base/fixtures/scopes/session.py

@@ -14,6 +14,10 @@ from winipedia_utils.git.gitignore.gitignore import _gitignore_is_correct
 from winipedia_utils.git.pre_commit.config import (
     _pre_commit_config_is_correct,
 )
+from winipedia_utils.git.workflows.publish import (
+    PUBLISH_WORKFLOW_PATH,
+    _publish_config_is_correct,
+)
 from winipedia_utils.modules.module import to_path
 from winipedia_utils.modules.package import (
     find_packages,
@@ -164,6 +168,23 @@ def _test_gitignore_is_correct() -> None:
     )
 
 
+@autouse_session_fixture
+def _test_publish_workflow_is_correct() -> None:
+    """Verify that the publish workflow is correctly defined.
+
+    If the file does not exist, we skip this test bc not all projects necessarily
+    need to publish to pypi, e.g. they are binaries or private usage only or for profit.
+    """
+    path = PUBLISH_WORKFLOW_PATH
+    # if folder exists but the file not then we skip this test
+    if path.parent.exists() and not path.exists():
+        return
+    assert_with_msg(
+        _publish_config_is_correct(),
+        "Publish workflow is not correct.",
+    )
+
+
 @autouse_session_fixture
 def _test_no_namespace_packages() -> None:
     """Verify that there are no namespace packages in the project.