agentrules 3.4.1__tar.gz → 3.4.2__tar.gz

{agentrules-3.4.1/src/agentrules.egg-info → agentrules-3.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: agentrules
-Version: 3.4.1
+Version: 3.4.2
 Summary: AGENTS.md/CLAUDE.md generator and ExecPlan harness for coding agents
 Author: trevor-nichols
 License-Expression: MIT
@@ -41,6 +41,7 @@ Dynamic: license-file
 <div align="center">
 
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
+[![PyPI](https://img.shields.io/pypi/v/agentrules.svg)](https://pypi.org/project/agentrules/)
 [![OpenAI](https://img.shields.io/badge/OpenAI-supported-blue.svg)](https://openai.com/)
 [![Codex Runtime](https://img.shields.io/badge/Codex%20app--server-supported-orange.svg)](https://github.com/openai/codex)
 [![Anthropic](https://img.shields.io/badge/Anthropic-supported-purple.svg)](https://www.anthropic.com/)
@@ -65,7 +66,7 @@ Version 3 rebrands the project from **CursorRules Architect** to **AgentRules Ar
 
 ## 🔥 v3 Highlights
 
-- ✨ **Rebrand & packaging** – ships with console-script and `python -m agentrules` entry points when installed from source.
+- ✨ **Rebrand & packaging** – ships on PyPI with console-script and `python -m agentrules` entry points.
 - 🧭 **Typer CLI overhaul** – `agentrules` launches an interactive main menu with subcommands for `analyze`, `configure`, and `keys`.
 - 🗂️ **Persistent settings** – API keys, model presets, logging, and output preferences live in `~/.config/agentrules/config.toml` (override with `AGENTRULES_CONFIG_DIR`).
 - 🧠 **Expanded provider matrix** – the preset catalog spans Anthropic, OpenAI, Google, DeepSeek, xAI, and Codex runtime presets, with phase-by-phase model selection from the CLI or config file.
@@ -116,9 +117,12 @@ The pipeline captures metrics (elapsed time, agent counts) and hands them to the
 ### Install from PyPI
 
 ```bash
-pip install agentrules
+pip install -U agentrules
 ```
 
+- Package page: <https://pypi.org/project/agentrules/>
+- Test index page: <https://test.pypi.org/project/agentrules/>
+
 ### Install from source
 
 ```bash
@@ -154,6 +158,12 @@ Need to install directly from GitHub instead of PyPI?
 pip install "git+https://github.com/trevor-nichols/agentrules-architect.git#egg=agentrules"
 ```
 
+Need to validate against TestPyPI specifically?
+
+```bash
+pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple agentrules==3.4.1
+```
+
 ## 🔐 Configure API Keys
 
 Run the interactive configurator to store credentials securely:
@@ -364,17 +374,21 @@ Toggle outputs with `agentrules configure --outputs` or via the config TOML.
 - Run targeted tests: `python tests/phase_3_test/run_test.py`
 - Deterministic smoke runs (CI/local without API calls): `agentrules analyze --offline tests/tests_input`
 - Full suite: `python -m unittest discover tests -v`
-- Releases are tag-driven: bump `[project].version` in `pyproject.toml`, commit, create matching `vX.Y.Z` tag, and push it.
+- Releases are Release Please-driven: merges to `main` update/open a release PR, and merging that PR creates the `vX.Y.Z` tag + GitHub release automatically.
 - GitHub Actions now publishes package artifacts with Trusted Publishing (OIDC) via `.github/workflows/publish-pypi.yml` (no long-lived PyPI API token).
-- Run a safe preflight publish first from Actions with `workflow_dispatch` and `repository = testpypi`; publish to production PyPI on tag push or manual `repository = pypi`.
+- Run a safe preflight publish first from Actions with `workflow_dispatch` and `repository = testpypi`; publish to production PyPI on release-tag push or manual `repository = pypi`.
 - Keep docs and presets in sync when adding providers (`config/agents.py`, `config/tools.py`, `core/agents/*`).
 
 ### Release Process (PyPI)
 
-1. Update `[project].version` in `pyproject.toml`, then commit and push.
-2. Run `.github/workflows/publish-pypi.yml` manually with `repository = testpypi` to validate package upload first.
-3. Create and push matching tag `vX.Y.Z` to trigger Trusted Publishing to PyPI.
-4. The same tag also triggers `.github/workflows/release.yml` for GitHub Release artifact/notes.
+1. Merge feature PRs into `main` using Conventional Commit-style titles/messages (for example `feat: ...`, `fix: ...`).
+2. `.github/workflows/release-please.yml` updates or opens a release PR with the version bump and changelog.
+3. (Optional, recommended) run `.github/workflows/publish-pypi.yml` manually with `repository = testpypi` from the release PR head commit.
+4. Merge the release PR. Release Please creates/pushes the matching `vX.Y.Z` tag and publishes a GitHub release.
+5. The tag push triggers `.github/workflows/publish-pypi.yml` to publish to production PyPI.
+6. One-time setup for new projects:
+   - Configure a repo secret `RELEASE_PLEASE_TOKEN` (PAT or GitHub App token) with permission to create/update PRs, tags, and releases. This ensures tag pushes from Release Please trigger downstream workflows.
+   - Configure Trusted Publishers on TestPyPI and PyPI for repository `trevor-nichols/agentrules-architect`, workflow `.github/workflows/publish-pypi.yml`, and environments `testpypi`/`pypi`.
 
 ## 🤝 Contributing
 

{agentrules-3.4.1 → agentrules-3.4.2}/README.md

@@ -3,6 +3,7 @@
 <div align="center">
 
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
+[![PyPI](https://img.shields.io/pypi/v/agentrules.svg)](https://pypi.org/project/agentrules/)
 [![OpenAI](https://img.shields.io/badge/OpenAI-supported-blue.svg)](https://openai.com/)
 [![Codex Runtime](https://img.shields.io/badge/Codex%20app--server-supported-orange.svg)](https://github.com/openai/codex)
 [![Anthropic](https://img.shields.io/badge/Anthropic-supported-purple.svg)](https://www.anthropic.com/)
@@ -27,7 +28,7 @@ Version 3 rebrands the project from **CursorRules Architect** to **AgentRules Ar
 
 ## 🔥 v3 Highlights
 
-- ✨ **Rebrand & packaging** – ships with console-script and `python -m agentrules` entry points when installed from source.
+- ✨ **Rebrand & packaging** – ships on PyPI with console-script and `python -m agentrules` entry points.
 - 🧭 **Typer CLI overhaul** – `agentrules` launches an interactive main menu with subcommands for `analyze`, `configure`, and `keys`.
 - 🗂️ **Persistent settings** – API keys, model presets, logging, and output preferences live in `~/.config/agentrules/config.toml` (override with `AGENTRULES_CONFIG_DIR`).
 - 🧠 **Expanded provider matrix** – the preset catalog spans Anthropic, OpenAI, Google, DeepSeek, xAI, and Codex runtime presets, with phase-by-phase model selection from the CLI or config file.
@@ -78,9 +79,12 @@ The pipeline captures metrics (elapsed time, agent counts) and hands them to the
 ### Install from PyPI
 
 ```bash
-pip install agentrules
+pip install -U agentrules
 ```
 
+- Package page: <https://pypi.org/project/agentrules/>
+- Test index page: <https://test.pypi.org/project/agentrules/>
+
 ### Install from source
 
 ```bash
@@ -116,6 +120,12 @@ Need to install directly from GitHub instead of PyPI?
 pip install "git+https://github.com/trevor-nichols/agentrules-architect.git#egg=agentrules"
 ```
 
+Need to validate against TestPyPI specifically?
+
+```bash
+pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple agentrules==3.4.1
+```
+
 ## 🔐 Configure API Keys
 
 Run the interactive configurator to store credentials securely:
@@ -326,17 +336,21 @@ Toggle outputs with `agentrules configure --outputs` or via the config TOML.
 - Run targeted tests: `python tests/phase_3_test/run_test.py`
 - Deterministic smoke runs (CI/local without API calls): `agentrules analyze --offline tests/tests_input`
 - Full suite: `python -m unittest discover tests -v`
-- Releases are tag-driven: bump `[project].version` in `pyproject.toml`, commit, create matching `vX.Y.Z` tag, and push it.
+- Releases are Release Please-driven: merges to `main` update/open a release PR, and merging that PR creates the `vX.Y.Z` tag + GitHub release automatically.
 - GitHub Actions now publishes package artifacts with Trusted Publishing (OIDC) via `.github/workflows/publish-pypi.yml` (no long-lived PyPI API token).
-- Run a safe preflight publish first from Actions with `workflow_dispatch` and `repository = testpypi`; publish to production PyPI on tag push or manual `repository = pypi`.
+- Run a safe preflight publish first from Actions with `workflow_dispatch` and `repository = testpypi`; publish to production PyPI on release-tag push or manual `repository = pypi`.
 - Keep docs and presets in sync when adding providers (`config/agents.py`, `config/tools.py`, `core/agents/*`).
 
 ### Release Process (PyPI)
 
-1. Update `[project].version` in `pyproject.toml`, then commit and push.
-2. Run `.github/workflows/publish-pypi.yml` manually with `repository = testpypi` to validate package upload first.
-3. Create and push matching tag `vX.Y.Z` to trigger Trusted Publishing to PyPI.
-4. The same tag also triggers `.github/workflows/release.yml` for GitHub Release artifact/notes.
+1. Merge feature PRs into `main` using Conventional Commit-style titles/messages (for example `feat: ...`, `fix: ...`).
+2. `.github/workflows/release-please.yml` updates or opens a release PR with the version bump and changelog.
+3. (Optional, recommended) run `.github/workflows/publish-pypi.yml` manually with `repository = testpypi` from the release PR head commit.
+4. Merge the release PR. Release Please creates/pushes the matching `vX.Y.Z` tag and publishes a GitHub release.
+5. The tag push triggers `.github/workflows/publish-pypi.yml` to publish to production PyPI.
+6. One-time setup for new projects:
+   - Configure a repo secret `RELEASE_PLEASE_TOKEN` (PAT or GitHub App token) with permission to create/update PRs, tags, and releases. This ensures tag pushes from Release Please trigger downstream workflows.
+   - Configure Trusted Publishers on TestPyPI and PyPI for repository `trevor-nichols/agentrules-architect`, workflow `.github/workflows/publish-pypi.yml`, and environments `testpypi`/`pypi`.
 
 ## 🤝 Contributing
 

{agentrules-3.4.1 → agentrules-3.4.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "agentrules"
-version = "3.4.1"
+version = "3.4.2"
 description = "AGENTS.md/CLAUDE.md generator and ExecPlan harness for coding agents"
 readme = "README.md"
 authors = [{name = "trevor-nichols"}]

{agentrules-3.4.1 → agentrules-3.4.2}/src/agentrules/core/utils/formatters/clean_agentrules.py

@@ -28,13 +28,46 @@ DEVELOPMENT_PRINCIPLES_HEADING_PATTERN = re.compile(
 MARKDOWN_HEADING_PATTERN = re.compile(r'^(?P<hashes>#{1,6})\s+\S')
 EXECPLANS_HEADING = "## ExecPlans"
 EXECPLANS_GUIDANCE_LINE = (
-    "When writing complex features or significant refactors, "
-    "use an ExecPlan (as described in .agent/PLANS.md) from design to implementation."
+    "- When writing complex features or refactors, use an ExecPlan "
+    "(as described in `.agent/PLANS.md`) from design to implementation."
+)
+EXECPLANS_MILESTONES_HEADING = "### Milestones"
+EXECPLANS_MILESTONES_LINE = (
+    "- When the feature or refactor your writing is significantly complex, "
+    "disaggregate the ExecPlan into milestones "
+    "(as described in `.agent/templates/MILESTONE_TEMPLATE.md`)"
+)
+EXECPLANS_CLI_HEADING = "### Prefer CLI creation over manual file creation:"
+EXECPLANS_CLI_LINES = (
+    "* ExecPlan:",
+    "  * Create: `agentrules execplan new \"<title>\" --slug <short-slug> --ms <N>` "
+    "(Use `--ms <N>` for deterministic `MS###` sequence assignment).",
+    "  * Archive: `agentrules execplan archive EP-YYYYMMDD-NNN`",
+    "* Milestones:",
+    "  * Create: `agentrules execplan milestone new EP-YYYYMMDD-NNN \"<Milestone Title>\"`",
+    "  * Archive: `agentrules execplan milestone archive EP-YYYYMMDD-NNN --ms <N>`",
+)
+EXECPLANS_GUIDANCE_BLOCK = (
+    EXECPLANS_HEADING,
+    EXECPLANS_GUIDANCE_LINE,
+    "",
+    EXECPLANS_MILESTONES_HEADING,
+    EXECPLANS_MILESTONES_LINE,
+    "",
+    EXECPLANS_CLI_HEADING,
+    *EXECPLANS_CLI_LINES,
+)
+EXECPLANS_REQUIRED_LINES = (
+    EXECPLANS_GUIDANCE_LINE,
+    EXECPLANS_MILESTONES_HEADING,
+    EXECPLANS_MILESTONES_LINE,
+    EXECPLANS_CLI_HEADING,
+    *EXECPLANS_CLI_LINES,
 )
 
 
 def _inject_execplans_guidance(content: str) -> tuple[str, bool, str]:
-    if EXECPLANS_GUIDANCE_LINE in content:
+    if all(line in content for line in EXECPLANS_REQUIRED_LINES):
         return content, False, "ExecPlans guidance already present."
 
     lines = content.splitlines()
@@ -54,8 +87,7 @@ def _inject_execplans_guidance(content: str) -> tuple[str, bool, str]:
             [
                 "# Development Principles",
                 "",
-                EXECPLANS_HEADING,
-                EXECPLANS_GUIDANCE_LINE,
+                *EXECPLANS_GUIDANCE_BLOCK,
             ]
         )
         return "\n".join(lines) + "\n", True, "Added missing Development Principles section with ExecPlans guidance."
@@ -71,16 +103,41 @@ def _inject_execplans_guidance(content: str) -> tuple[str, bool, str]:
             break
 
     section_lines = lines[heading_index:section_end]
-    for line in section_lines:
+    execplans_heading_index: int | None = None
+    execplans_heading_level = 0
+    for index, line in enumerate(section_lines):
         normalized = line.strip().lower().rstrip(":")
         if normalized == "## execplans" or normalized == "### execplans":
-            return content, False, "ExecPlans heading already present under Development Principles."
+            execplans_heading_index = heading_index + index
+            heading_match = MARKDOWN_HEADING_PATTERN.match(line.strip())
+            if heading_match:
+                execplans_heading_level = len(heading_match.group("hashes"))
+            break
+
+    if execplans_heading_index is not None:
+        execplans_block_end = section_end
+        for index in range(execplans_heading_index + 1, section_end):
+            line = lines[index]
+            heading_match = MARKDOWN_HEADING_PATTERN.match(line.strip())
+            if not heading_match:
+                continue
+            if len(heading_match.group("hashes")) <= execplans_heading_level:
+                execplans_block_end = index
+                break
+
+        replacement_lines = list(EXECPLANS_GUIDANCE_BLOCK)
+        updated_lines = lines[:execplans_heading_index] + replacement_lines + lines[execplans_block_end:]
+        return (
+            "\n".join(updated_lines) + "\n",
+            True,
+            "Updated existing ExecPlans guidance under Development Principles.",
+        )
 
     insert_at = section_end
     while insert_at > heading_index and not lines[insert_at - 1].strip():
         insert_at -= 1
 
-    insertion_lines = ["", EXECPLANS_HEADING, EXECPLANS_GUIDANCE_LINE, ""]
+    insertion_lines = ["", *EXECPLANS_GUIDANCE_BLOCK, ""]
     updated_lines = lines[:insert_at] + insertion_lines + lines[section_end:]
     return "\n".join(updated_lines) + "\n", True, "Added ExecPlans guidance under Development Principles."
 

{agentrules-3.4.1 → agentrules-3.4.2/src/agentrules.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: agentrules
-Version: 3.4.1
+Version: 3.4.2
 Summary: AGENTS.md/CLAUDE.md generator and ExecPlan harness for coding agents
 Author: trevor-nichols
 License-Expression: MIT
@@ -41,6 +41,7 @@ Dynamic: license-file
 <div align="center">
 
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
+[![PyPI](https://img.shields.io/pypi/v/agentrules.svg)](https://pypi.org/project/agentrules/)
 [![OpenAI](https://img.shields.io/badge/OpenAI-supported-blue.svg)](https://openai.com/)
 [![Codex Runtime](https://img.shields.io/badge/Codex%20app--server-supported-orange.svg)](https://github.com/openai/codex)
 [![Anthropic](https://img.shields.io/badge/Anthropic-supported-purple.svg)](https://www.anthropic.com/)
@@ -65,7 +66,7 @@ Version 3 rebrands the project from **CursorRules Architect** to **AgentRules Ar
 
 ## 🔥 v3 Highlights
 
-- ✨ **Rebrand & packaging** – ships with console-script and `python -m agentrules` entry points when installed from source.
+- ✨ **Rebrand & packaging** – ships on PyPI with console-script and `python -m agentrules` entry points.
 - 🧭 **Typer CLI overhaul** – `agentrules` launches an interactive main menu with subcommands for `analyze`, `configure`, and `keys`.
 - 🗂️ **Persistent settings** – API keys, model presets, logging, and output preferences live in `~/.config/agentrules/config.toml` (override with `AGENTRULES_CONFIG_DIR`).
 - 🧠 **Expanded provider matrix** – the preset catalog spans Anthropic, OpenAI, Google, DeepSeek, xAI, and Codex runtime presets, with phase-by-phase model selection from the CLI or config file.
@@ -116,9 +117,12 @@ The pipeline captures metrics (elapsed time, agent counts) and hands them to the
 ### Install from PyPI
 
 ```bash
-pip install agentrules
+pip install -U agentrules
 ```
 
+- Package page: <https://pypi.org/project/agentrules/>
+- Test index page: <https://test.pypi.org/project/agentrules/>
+
 ### Install from source
 
 ```bash
@@ -154,6 +158,12 @@ Need to install directly from GitHub instead of PyPI?
 pip install "git+https://github.com/trevor-nichols/agentrules-architect.git#egg=agentrules"
 ```
 
+Need to validate against TestPyPI specifically?
+
+```bash
+pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple agentrules==3.4.1
+```
+
 ## 🔐 Configure API Keys
 
 Run the interactive configurator to store credentials securely:
@@ -364,17 +374,21 @@ Toggle outputs with `agentrules configure --outputs` or via the config TOML.
 - Run targeted tests: `python tests/phase_3_test/run_test.py`
 - Deterministic smoke runs (CI/local without API calls): `agentrules analyze --offline tests/tests_input`
 - Full suite: `python -m unittest discover tests -v`
-- Releases are tag-driven: bump `[project].version` in `pyproject.toml`, commit, create matching `vX.Y.Z` tag, and push it.
+- Releases are Release Please-driven: merges to `main` update/open a release PR, and merging that PR creates the `vX.Y.Z` tag + GitHub release automatically.
 - GitHub Actions now publishes package artifacts with Trusted Publishing (OIDC) via `.github/workflows/publish-pypi.yml` (no long-lived PyPI API token).
-- Run a safe preflight publish first from Actions with `workflow_dispatch` and `repository = testpypi`; publish to production PyPI on tag push or manual `repository = pypi`.
+- Run a safe preflight publish first from Actions with `workflow_dispatch` and `repository = testpypi`; publish to production PyPI on release-tag push or manual `repository = pypi`.
 - Keep docs and presets in sync when adding providers (`config/agents.py`, `config/tools.py`, `core/agents/*`).
 
 ### Release Process (PyPI)
 
-1. Update `[project].version` in `pyproject.toml`, then commit and push.
-2. Run `.github/workflows/publish-pypi.yml` manually with `repository = testpypi` to validate package upload first.
-3. Create and push matching tag `vX.Y.Z` to trigger Trusted Publishing to PyPI.
-4. The same tag also triggers `.github/workflows/release.yml` for GitHub Release artifact/notes.
+1. Merge feature PRs into `main` using Conventional Commit-style titles/messages (for example `feat: ...`, `fix: ...`).
+2. `.github/workflows/release-please.yml` updates or opens a release PR with the version bump and changelog.
+3. (Optional, recommended) run `.github/workflows/publish-pypi.yml` manually with `repository = testpypi` from the release PR head commit.
+4. Merge the release PR. Release Please creates/pushes the matching `vX.Y.Z` tag and publishes a GitHub release.
+5. The tag push triggers `.github/workflows/publish-pypi.yml` to publish to production PyPI.
+6. One-time setup for new projects:
+   - Configure a repo secret `RELEASE_PLEASE_TOKEN` (PAT or GitHub App token) with permission to create/update PRs, tags, and releases. This ensures tag pushes from Release Please trigger downstream workflows.
+   - Configure Trusted Publishers on TestPyPI and PyPI for repository `trevor-nichols/agentrules-architect`, workflow `.github/workflows/publish-pypi.yml`, and environments `testpypi`/`pypi`.
 
 ## 🤝 Contributing