apexcodexpy 0.5.4__tar.gz → 0.6.2__tar.gz

{apexcodexpy-0.5.4 → apexcodexpy-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: apexcodexpy
-Version: 0.5.4
+Version: 0.6.2
 Summary: The Non-Destructive Configuration Steward for Python Projects.
 License-File: LICENSE
 Author: Apex Dev

{apexcodexpy-0.5.4 → apexcodexpy-0.6.2}/codex/infra/service.py

@@ -17,7 +17,11 @@ from codex.infra.tools import (
     Ruff,
     Version,
 )
-from codex.infra.workflows import CheckCodeWorkflow, DependabotWorkflow
+from codex.infra.workflows import (
+    BuildCodeWorkflow,
+    CheckCodeWorkflow,
+    DependabotWorkflow,
+)
 
 
 @dataclass(frozen=True)
@@ -38,8 +42,8 @@ class Codex:
     def version() -> TaskResult:
         return ProgramResult(name="version").success(message=str(Version()))
 
-    def sync(self) -> TaskResult:
-        return self.tools.sync().execute()
+    def sync(self, force: bool) -> TaskResult:
+        return self.tools.sync(force).execute()
 
     def lock(self) -> TaskResult:
         return self.tools.lock().execute()
@@ -126,12 +130,13 @@ class CiCodex:
 class CodexTools:
     target: Path
 
-    def sync(self) -> Executable:
+    def sync(self, force: bool) -> Executable:
         return (
             MultiProgram()
             .attach(PyProjectToml().sync(self.target))
-            .attach(DependabotWorkflow().sync(self.target))
-            .attach(CheckCodeWorkflow().sync(self.target))
+            .attach(DependabotWorkflow().sync(self.target, force=force))
+            .attach(CheckCodeWorkflow().sync(self.target, force=force))
+            .attach(BuildCodeWorkflow(disclaimer=False).sync(self.target, force=force))
         )
 
     def lock(self) -> Executable:

{apexcodexpy-0.5.4 → apexcodexpy-0.6.2}/codex/infra/typer/root.py

@@ -27,10 +27,16 @@ def _(
         "-p",
         help="Target directory.",
     ),
+    force: bool = typer.Option(
+        False,
+        "--force",
+        "-f",
+        help="Force sync.",
+    ),
 ) -> None:
     (
         Codex.target(Path(path))
-        .sync()
+        .sync(force=force)
         .report(using=DefaultReporter())
         .exit(using=typer.Exit)
     )

apexcodexpy-0.6.2/codex/infra/workflows/__init__.py

@@ -0,0 +1,9 @@
+from .build import BuildCodeWorkflow
+from .dependabot import DependabotWorkflow
+from .validate import CheckCodeWorkflow
+
+__all__ = [
+    "DependabotWorkflow",
+    "BuildCodeWorkflow",
+    "CheckCodeWorkflow",
+]

apexcodexpy-0.6.2/codex/infra/workflows/base.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from datetime import UTC, datetime
+from pathlib import Path
+
+from codex.infra.program import Executable
+from codex.infra.result import ProgramResult
+from codex.infra.tools import Version
+from codex.infra.yamler import Yamler
+
+
+@dataclass(frozen=True, kw_only=True)
+class YamlWorkflow(ABC):
+    name: str
+    path: Path
+
+    disclaimer: bool = True
+
+    @property
+    @abstractmethod
+    def standards(self) -> Yamler:
+        pass
+
+    def sync(self, target: Path, force: bool = False) -> Executable:
+        path = target / self.path
+        path.parent.mkdir(parents=True, exist_ok=True)
+        path.touch(exist_ok=True)
+
+        standards = self.standards
+        if not force and Yamler.read(path) == standards:
+            return ProgramResult(name=self.name).no_changes()
+
+        if self.disclaimer:
+            standards = standards.comment(
+                "Auto Generated",
+                f"By: Apex Codex {Version()}",
+                f"At: {self._utcnow()}",
+                "Do not edit this file manually!\n\n",
+            )
+
+        standards.dump_to(path)
+
+        return self.success()
+
+    def _utcnow(self) -> str:
+        return datetime.now(tz=UTC).replace(microsecond=0).isoformat(sep=" ")
+
+    def success(self) -> ProgramResult:
+        return ProgramResult(name=self.name).success(
+            message=f"{self.name} workflow succeeded.\n"
+        )

apexcodexpy-0.6.2/codex/infra/workflows/build.py

@@ -0,0 +1,78 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+
+from ruamel.yaml.scalarstring import FoldedScalarString
+
+from codex.infra.tools import Version
+from codex.infra.yamler import Yamler
+
+from .base import YamlWorkflow
+from .ci import CiJob
+
+
+@dataclass(frozen=True, kw_only=True)
+class BuildCodeWorkflow(YamlWorkflow):
+    name: str = "BuildCode"
+    path: Path = Path(".github") / "workflows" / "build_code.yml"
+
+    @property
+    def standards(self) -> Yamler:
+        workflow = Yamler.read(self.path).as_mapping()
+        workflow["name"] = "Build Python Application"
+        workflow["on"] = {"push": {"branches": ["main"]}}
+        workflow["permissions"] = "write-all"
+        workflow["jobs"] = workflow.get("jobs", {})
+        workflow["jobs"]["build"] = (
+            CiJob(name="build")
+            .with_step(
+                Yamler.parse(
+                    {
+                        "name": "Checkout Code",
+                        "uses": "actions/checkout@v7",
+                    }
+                )
+            )
+            .with_step(
+                Yamler.parse(
+                    {
+                        "name": "Setup Python",
+                        "uses": "actions/setup-python@v6",
+                        "with": {
+                            "python-version": Version.of_python(),
+                            "pip-install": "apexcodexpy",
+                        },
+                    }
+                )
+            )
+            .run(
+                step="Build Docker image",
+                command=FoldedScalarString(
+                    "\n".join(
+                        [
+                            "codex build",
+                            "  --tag ${{ github.event.repository.name }}:latest",
+                        ]
+                    )
+                ),
+            )
+            .run(
+                step="Push Docker image",
+                command=FoldedScalarString(
+                    "\n".join(
+                        [
+                            "codex push",
+                            "  --tag ${{ github.event.repository.name }}:latest",
+                            "  --token ${{ secrets.GITHUB_TOKEN }}",
+                            "  --actor ${{ github.actor }}",
+                            "  --organization ${{ github.repository_owner }}",
+                        ]
+                    )
+                ),
+            )
+            .yamlify()
+            .as_mapping()
+        )
+
+        return Yamler.parse(workflow)

apexcodexpy-0.6.2/codex/infra/workflows/ci.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+from collections.abc import MutableMapping, MutableSequence
+from dataclasses import dataclass, field, replace
+
+from codex.infra.yamler import Yamler
+
+
+@dataclass(frozen=True)
+class CiWorkflow:
+    name: str
+
+    jobs: MutableMapping[str, Yamler] = field(default_factory=dict)
+
+    def with_job(self, value: CiJob) -> CiWorkflow:
+        if value.is_enabled:
+            self.jobs[value.name] = value.yamlify()
+
+        return self
+
+    def yamlify(self) -> Yamler:
+        return Yamler.parse(
+            {
+                "name": self.name,
+                "on": {"pull_request": {"branches": ["main"]}},
+                "permissions": {"contents": "read"},
+                "jobs": {name: job.as_mapping() for name, job in self.jobs.items()},
+            }
+        )
+
+
+@dataclass(frozen=True)
+class CiJob:
+    name: str
+
+    is_enabled: bool = True
+    platform: str = "ubuntu-latest"
+    steps: MutableSequence[Yamler] = field(default_factory=list)
+
+    def with_step(self, step: Yamler) -> CiJob:
+        self.steps.append(step)
+
+        return self
+
+    def run(self, step: str, command: str) -> CiJob:
+        return self.with_step(Yamler.parse({"name": step, "run": command}))
+
+    def enabled(self, when: bool) -> CiJob:
+        return replace(self, is_enabled=when)
+
+    def yamlify(self) -> Yamler:
+        return Yamler.parse(
+            {
+                "runs-on": self.platform,
+                "steps": [step.as_mapping() for step in self.steps],
+            }
+        )

apexcodexpy-0.6.2/codex/infra/workflows/dependabot.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+
+from codex.infra.yamler import Yamler
+
+from .base import YamlWorkflow
+
+
+@dataclass(frozen=True, kw_only=True)
+class DependabotWorkflow(YamlWorkflow):
+    name: str = "Dependabot"
+    path: Path = Path(".github") / "dependabot.yml"
+
+    @property
+    def standards(self) -> Yamler:
+        return Yamler.parse(
+            {
+                "version": 2,
+                "updates": [
+                    self._pip_config().as_mapping(),
+                    self._gh_actions_config().as_mapping(),
+                ],
+            }
+        )
+
+    @staticmethod
+    def _pip_config() -> Yamler:
+        return Yamler.parse(
+            {
+                "package-ecosystem": "pip",
+                "directory": "/",
+                "schedule": {
+                    "interval": "weekly",
+                    "day": "thursday",
+                },
+                "groups": {
+                    "python": {
+                        "patterns": ["*"],
+                    }
+                },
+            }
+        )
+
+    @staticmethod
+    def _gh_actions_config() -> Yamler:
+        return Yamler.parse(
+            {
+                "package-ecosystem": "github-actions",
+                "directory": "/",
+                "schedule": {
+                    "interval": "weekly",
+                    "day": "thursday",
+                },
+                "groups": {
+                    "gh-actions": {
+                        "patterns": ["*"],
+                    }
+                },
+            }
+        )

apexcodexpy-0.6.2/codex/infra/workflows/validate.py

@@ -0,0 +1,81 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+
+from codex.infra.tools import Version
+from codex.infra.yamler import Yamler
+
+from .base import YamlWorkflow
+from .ci import CiJob, CiWorkflow
+
+
+@dataclass(frozen=True, kw_only=True)
+class CheckCodeWorkflow(YamlWorkflow):
+    name: str = "CheckCode"
+    path: Path = Path(".github") / "workflows" / "check_code.yml"
+
+    CHECKOUT = Yamler.parse(
+        {
+            "name": "Checkout Code",
+            "uses": "actions/checkout@v7",
+        }
+    ).anchor("checkout")
+
+    SETUP = Yamler.parse(
+        {
+            "name": "Setup Python",
+            "uses": "actions/setup-python@v6",
+            "with": {
+                "python-version": Version.of_python(),
+                "pip-install": f"apexcodexpy=={Version()}",
+            },
+        }
+    ).anchor("setup")
+
+    @property
+    def standards(self) -> Yamler:
+        return (
+            CiWorkflow(name="Validate Python Code")
+            .with_job(
+                CiJob(name="lint")
+                .with_step(self.CHECKOUT)
+                .with_step(self.SETUP)
+                .run(
+                    step="Lint Code",
+                    command="codex lint --ci",
+                )
+                .enabled(True)
+            )
+            .with_job(
+                CiJob(name="test-unit")
+                .with_step(self.CHECKOUT)
+                .with_step(self.SETUP)
+                .run(
+                    step="Run unit tests",
+                    command="codex test unit --ci",
+                )
+                .enabled(True)
+            )
+            .with_job(
+                CiJob(name="test-integration")
+                .with_step(self.CHECKOUT)
+                .with_step(self.SETUP)
+                .run(
+                    step="Run integration tests",
+                    command="codex test integration --ci",
+                )
+                .enabled(when=Version().is_installed("pytest-docker"))
+            )
+            .with_job(
+                CiJob(name="test-behaviour")
+                .with_step(self.CHECKOUT)
+                .with_step(self.SETUP)
+                .run(
+                    step="Run behaviour tests",
+                    command="codex test behaviour --ci",
+                )
+                .enabled(when=Version().is_installed("behave"))
+            )
+            .yamlify()
+        )

{apexcodexpy-0.5.4 → apexcodexpy-0.6.2}/codex/infra/yamler.py

@@ -18,7 +18,7 @@ class Yamler:
 
     @classmethod
     def read(cls, path: Path) -> Yamler:
-        return cls(value=YAML().load(path))
+        return cls(value=YAML(typ="safe").load(path) or CommentedMap())
 
     @classmethod
     def parse(cls, data: Mapping[str, Any]) -> Yamler:

{apexcodexpy-0.5.4 → apexcodexpy-0.6.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "apexcodexpy"
-version = "0.5.4"
+version = "0.6.2"
 description = "The Non-Destructive Configuration Steward for Python Projects."
 readme = "README.md"
 authors = [

apexcodexpy-0.5.4/codex/infra/workflows.py

@@ -1,222 +0,0 @@
-from __future__ import annotations
-
-from abc import ABC, abstractmethod
-from collections.abc import MutableMapping, MutableSequence
-from dataclasses import dataclass, field, replace
-from datetime import UTC, datetime
-from pathlib import Path
-
-from codex.infra.program import Executable
-from codex.infra.result import ProgramResult
-from codex.infra.tools import Version
-from codex.infra.yamler import Yamler
-
-
-@dataclass(frozen=True, kw_only=True)
-class YamlWorkflow(ABC):
-    name: str
-    path: Path
-
-    @property
-    @abstractmethod
-    def standards(self) -> Yamler:
-        pass
-
-    def sync(self, target: Path) -> Executable:
-        path = target / self.path
-        path.parent.mkdir(parents=True, exist_ok=True)
-        path.touch(exist_ok=True)
-
-        if Yamler.read(path) == self.standards:
-            return ProgramResult(name=self.name).no_changes()
-
-        self.standards.comment(
-            "Auto Generated",
-            f"By: Apex Codex {Version()}",
-            f"At: {self._utcnow()}",
-            "Do not edit this file manually!\n\n",
-        ).dump_to(path)
-
-        return self.success()
-
-    def _utcnow(self) -> str:
-        return datetime.now(tz=UTC).replace(microsecond=0).isoformat(sep=" ")
-
-    def success(self) -> ProgramResult:
-        return ProgramResult(name=self.name).success(
-            message=f"{self.name} workflow succeeded.\n"
-        )
-
-
-@dataclass(frozen=True, kw_only=True)
-class DependabotWorkflow(YamlWorkflow):
-    name: str = "Dependabot"
-    path: Path = Path(".github") / "dependabot.yml"
-
-    @property
-    def standards(self) -> Yamler:
-        return Yamler.parse(
-            {
-                "version": 2,
-                "updates": [
-                    self._pip_config().as_mapping(),
-                    self._gh_actions_config().as_mapping(),
-                ],
-            }
-        )
-
-    @staticmethod
-    def _pip_config() -> Yamler:
-        return Yamler.parse(
-            {
-                "package-ecosystem": "pip",
-                "directory": "/",
-                "schedule": {
-                    "interval": "weekly",
-                    "day": "thursday",
-                },
-                "groups": {
-                    "python": {
-                        "patterns": ["*"],
-                    }
-                },
-            }
-        )
-
-    @staticmethod
-    def _gh_actions_config() -> Yamler:
-        return Yamler.parse(
-            {
-                "package-ecosystem": "github-actions",
-                "directory": "/",
-                "schedule": {
-                    "interval": "weekly",
-                    "day": "thursday",
-                },
-                "groups": {
-                    "gh-actions": {
-                        "patterns": ["*"],
-                    }
-                },
-            }
-        )
-
-
-@dataclass(frozen=True, kw_only=True)
-class CheckCodeWorkflow(YamlWorkflow):
-    name: str = "CheckCode"
-    path: Path = Path(".github") / "workflows" / "check_code.yml"
-
-    @property
-    def standards(self) -> Yamler:
-        return (
-            CiWorkflow(name="Validate Python Code")
-            .with_job(
-                CodeCheckJob(name="lint")
-                .run(
-                    step="Lint Code",
-                    command="codex lint --ci",
-                )
-                .enabled(True)
-            )
-            .with_job(
-                CodeCheckJob(name="test-unit")
-                .run(
-                    step="Run unit tests",
-                    command="codex test unit --ci",
-                )
-                .enabled(True)
-            )
-            .with_job(
-                CodeCheckJob(name="test-integration")
-                .run(
-                    step="Run integration tests",
-                    command="codex test integration --ci",
-                )
-                .enabled(when=Version().is_installed("pytest-docker"))
-            )
-            .with_job(
-                CodeCheckJob(name="test-behaviour")
-                .run(
-                    step="Run behaviour tests",
-                    command="codex test behaviour --ci",
-                )
-                .enabled(when=Version().is_installed("behave"))
-            )
-            .yamlify()
-        )
-
-
-@dataclass(frozen=True)
-class CiWorkflow:
-    name: str
-
-    jobs: MutableMapping[str, Yamler] = field(default_factory=dict)
-
-    def with_job(self, value: CiJob) -> CiWorkflow:
-        if value.is_enabled:
-            self.jobs[value.name] = value.yamlify()
-
-        return self
-
-    def yamlify(self) -> Yamler:
-        return Yamler.parse(
-            {
-                "name": self.name,
-                "on": {"pull_request": {"branches": ["main"]}},
-                "permissions": {"contents": "read"},
-                "jobs": {name: job.as_mapping() for name, job in self.jobs.items()},
-            }
-        )
-
-
-@dataclass(frozen=True)
-class CiJob:
-    name: str
-
-    is_enabled: bool = True
-    platform: str = "ubuntu-latest"
-    steps: MutableSequence[Yamler] = field(default_factory=list)
-
-    def with_step(self, step: Yamler) -> CiJob:
-        self.steps.append(step)
-
-        return self
-
-    def enabled(self, when: bool) -> CiJob:
-        return replace(self, is_enabled=when)
-
-    def yamlify(self) -> Yamler:
-        return Yamler.parse(
-            {
-                "runs-on": self.platform,
-                "steps": [step.as_mapping() for step in self.steps],
-            }
-        )
-
-
-CHECKOUT = Yamler.parse(
-    {
-        "name": "Checkout Code",
-        "uses": "actions/checkout@v7",
-    }
-).anchor("checkout")
-
-SETUP = Yamler.parse(
-    {
-        "name": "Setup Python",
-        "uses": "actions/setup-python@v6",
-        "with": {
-            "python-version": Version.of_python(),
-            "pip-install": f"apexcodexpy=={Version()}",
-        },
-    }
-).anchor("setup")
-
-
-@dataclass(frozen=True)
-class CodeCheckJob(CiJob):
-    steps: MutableSequence[Yamler] = field(default_factory=lambda: [CHECKOUT, SETUP])
-
-    def run(self, step: str, command: str) -> CiJob:
-        return self.with_step(Yamler.parse({"name": step, "run": command}))