bugyo-prjmeta 1.0.0__tar.gz

bugyo_prjmeta-1.0.0/.gitignore

@@ -0,0 +1,62 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Logs
+logs/
+*.log
+
+# Configuration secrets
+.daimyo/config/.secrets.toml
+config/.secrets.toml
+.secrets.toml
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Hatch
+.hatch/
+
+# Type checking
+.mypy_cache/
+.dmypy.json
+dmypy.json

bugyo_prjmeta-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jesús Alonso Abad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bugyo_prjmeta-1.0.0/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: bugyo-prjmeta
+Version: 1.0.0
+Summary: Project metadata plugin for Daimyo - provides .project-metadata.yml content for templates
+Project-URL: Homepage, https://gitlab.com/Kencho1/daimyo
+Project-URL: Documentation, https://gitlab.com/Kencho1/daimyo/-/blob/main/plugins/bugyo-prjmeta/README.md
+Project-URL: Repository, https://gitlab.com/Kencho1/daimyo
+Project-URL: Issues, https://gitlab.com/Kencho1/daimyo/-/issues
+Author: Jesús Alonso Abad
+License: MIT License
+        
+        Copyright (c) 2026 Jesús Alonso Abad
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: daimyo,jinja2,metadata,plugin,project,templates
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: daimyo>=1.4.0
+Requires-Dist: pyyaml~=6.0
+Description-Content-Type: text/markdown
+
+# bugyo-prjmeta
+
+Project metadata plugin for Daimyo - provides `.project-metadata.yml` content for Jinja2 templates.
+
+## Installation
+
+```bash
+pip install bugyo-prjmeta
+```
+
+## Requirements
+
+- Python >= 3.11
+- daimyo >= 1.4.0
+- pyyaml ~= 6.0
+
+## Features
+
+### Context Variables
+
+The `prjmeta.context` plugin provides the following template variable:
+
+| Variable | Type | Description |
+|----------|------|-------------|
+| `project_metadata` | dict | Full contents of `.project-metadata.yml` in the project root |
+
+## Configuration
+
+Enable the plugin in your `.daimyo/config/settings.toml`:
+
+```toml
+# Enable all project metadata plugins
+enabled_plugins = ["prjmeta.*"]
+
+# Or enable the specific context plugin
+enabled_plugins = ["prjmeta.context"]
+```
+
+## Usage
+
+### Template Examples
+
+#### Conditional Rules Based on Project Metadata
+
+```yaml
+project.language:
+  when: Language-specific guidelines
+  ruleset:
+    - "{% if project_metadata.get('language') == 'python' %}Use uv for dependency management{% endif %}"
+    - "{% if project_metadata.get('language') == 'javascript' %}Use npm or yarn for dependency management{% endif %}"
+```
+
+#### Using Daimyo Scope
+
+The `.project-metadata.yml` file is used by Claude Code to determine the daimyo rule scope.
+Its full contents are also available in templates:
+
+```yaml
+project.info:
+  when: Project information rules
+  ruleset:
+    - "{% if project_metadata.get('daimyo', {}).get('scope') %}Rules scope: {{ project_metadata.daimyo.scope }}{% endif %}"
+    - "{% if project_metadata.get('team') %}Team: {{ project_metadata.team }}{% endif %}"
+```
+
+#### Accessing Nested Metadata
+
+```yaml
+project.team:
+  when: Team-specific guidelines
+  ruleset:
+    - "{% set team = project_metadata.get('team', {}) %}"
+    - "{% if team.get('timezone') %}Team timezone: {{ team.timezone }}{% endif %}"
+    - "{% if team.get('lead') %}Technical lead: {{ team.lead }}{% endif %}"
+```
+
+## Availability
+
+The plugin is **always available**, even when `.project-metadata.yml` does not exist in the project root. In that case, `project_metadata` is an empty dict `{}`.
+
+## Security
+
+This plugin reads only `.project-metadata.yml` from the current working directory. No path traversal is possible - the file path is fixed and cannot be influenced by template authors.
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Support
+
+For issues and questions, please visit the [Daimyo issue tracker](https://gitlab.com/Kencho1/daimyo/-/issues).

bugyo_prjmeta-1.0.0/README.md

@@ -0,0 +1,91 @@
+# bugyo-prjmeta
+
+Project metadata plugin for Daimyo - provides `.project-metadata.yml` content for Jinja2 templates.
+
+## Installation
+
+```bash
+pip install bugyo-prjmeta
+```
+
+## Requirements
+
+- Python >= 3.11
+- daimyo >= 1.4.0
+- pyyaml ~= 6.0
+
+## Features
+
+### Context Variables
+
+The `prjmeta.context` plugin provides the following template variable:
+
+| Variable | Type | Description |
+|----------|------|-------------|
+| `project_metadata` | dict | Full contents of `.project-metadata.yml` in the project root |
+
+## Configuration
+
+Enable the plugin in your `.daimyo/config/settings.toml`:
+
+```toml
+# Enable all project metadata plugins
+enabled_plugins = ["prjmeta.*"]
+
+# Or enable the specific context plugin
+enabled_plugins = ["prjmeta.context"]
+```
+
+## Usage
+
+### Template Examples
+
+#### Conditional Rules Based on Project Metadata
+
+```yaml
+project.language:
+  when: Language-specific guidelines
+  ruleset:
+    - "{% if project_metadata.get('language') == 'python' %}Use uv for dependency management{% endif %}"
+    - "{% if project_metadata.get('language') == 'javascript' %}Use npm or yarn for dependency management{% endif %}"
+```
+
+#### Using Daimyo Scope
+
+The `.project-metadata.yml` file is used by Claude Code to determine the daimyo rule scope.
+Its full contents are also available in templates:
+
+```yaml
+project.info:
+  when: Project information rules
+  ruleset:
+    - "{% if project_metadata.get('daimyo', {}).get('scope') %}Rules scope: {{ project_metadata.daimyo.scope }}{% endif %}"
+    - "{% if project_metadata.get('team') %}Team: {{ project_metadata.team }}{% endif %}"
+```
+
+#### Accessing Nested Metadata
+
+```yaml
+project.team:
+  when: Team-specific guidelines
+  ruleset:
+    - "{% set team = project_metadata.get('team', {}) %}"
+    - "{% if team.get('timezone') %}Team timezone: {{ team.timezone }}{% endif %}"
+    - "{% if team.get('lead') %}Technical lead: {{ team.lead }}{% endif %}"
+```
+
+## Availability
+
+The plugin is **always available**, even when `.project-metadata.yml` does not exist in the project root. In that case, `project_metadata` is an empty dict `{}`.
+
+## Security
+
+This plugin reads only `.project-metadata.yml` from the current working directory. No path traversal is possible - the file path is fixed and cannot be influenced by template authors.
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Support
+
+For issues and questions, please visit the [Daimyo issue tracker](https://gitlab.com/Kencho1/daimyo/-/issues).

bugyo_prjmeta-1.0.0/bugyo_prjmeta/__init__.py

@@ -0,0 +1,4 @@
+"""Bugyo-PrjMeta: Project metadata plugin for Daimyo."""
+
+__version__ = "1.0.0"
+__all__ = ["__version__"]

bugyo_prjmeta-1.0.0/bugyo_prjmeta/plugins.py

@@ -0,0 +1,48 @@
+"""Project metadata plugin for Daimyo.
+
+Provides project metadata from .project-metadata.yml for Jinja2 templates.
+"""
+
+from pathlib import Path
+from typing import Any
+
+import yaml
+
+from daimyo.domain import ContextProviderPlugin, MergedScope
+
+
+class ProjectMetadataContextPlugin(ContextProviderPlugin):
+    """Provides project metadata from .project-metadata.yml for templates.
+
+    Reads the .project-metadata.yml file from the current working directory
+    and exposes its contents as the ``project_metadata`` template variable.
+    If the file does not exist, an empty dict is returned.
+    """
+
+    @property
+    def name(self) -> str:
+        return "prjmeta.context"
+
+    @property
+    def description(self) -> str:
+        return "Provides project metadata from .project-metadata.yml for templates"
+
+    def is_available(self) -> bool:
+        """Always available."""
+        return True
+
+    def get_context(self, scope: MergedScope) -> dict[str, Any]:
+        """Return project metadata context variables.
+
+        :param scope: The merged scope being rendered
+        :type scope: MergedScope
+        :returns: Dictionary containing ``project_metadata`` key with parsed YAML content
+        :rtype: dict[str, Any]
+        """
+        metadata_file = Path.cwd() / ".project-metadata.yml"
+
+        if not metadata_file.exists():
+            return {"project_metadata": {}}
+
+        data = yaml.safe_load(metadata_file.read_text())
+        return {"project_metadata": data or {}}

bugyo_prjmeta-1.0.0/pyproject.toml

@@ -0,0 +1,96 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "bugyo-prjmeta"
+dynamic = ["version"]
+description = "Project metadata plugin for Daimyo - provides .project-metadata.yml content for templates"
+readme = "README.md"
+requires-python = ">=3.11"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Jesús Alonso Abad"},
+]
+keywords = ["daimyo", "plugin", "project", "metadata", "templates", "jinja2"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+
+dependencies = [
+    "daimyo>=1.4.0",
+    "pyyaml~=6.0",
+]
+
+[project.urls]
+Homepage = "https://gitlab.com/Kencho1/daimyo"
+Documentation = "https://gitlab.com/Kencho1/daimyo/-/blob/main/plugins/bugyo-prjmeta/README.md"
+Repository = "https://gitlab.com/Kencho1/daimyo"
+Issues = "https://gitlab.com/Kencho1/daimyo/-/issues"
+
+[project.entry-points."daimyo.plugins"]
+"prjmeta.context" = "bugyo_prjmeta.plugins:ProjectMetadataContextPlugin"
+
+[tool.hatch.version]
+path = "bugyo_prjmeta/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["bugyo_prjmeta"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "bugyo_prjmeta/**/*.py",
+    "tests/**/*.py",
+    "README.md",
+    "LICENSE",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "-v --strict-markers --tb=short"
+
+[tool.mypy]
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_any_generics = true
+check_untyped_defs = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+follow_imports = "normal"
+show_error_codes = true
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "UP", # pyupgrade",
+]
+ignore = []
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = ["D"]

bugyo_prjmeta-1.0.0/tests/conftest.py

@@ -0,0 +1,39 @@
+"""Test fixtures for bugyo-prjmeta plugin tests."""
+
+import pytest
+from daimyo.domain import MergedScope, RuleSet, ScopeMetadata
+
+
+@pytest.fixture
+def sample_merged_scope():
+    """Create a sample merged scope for testing."""
+    metadata = ScopeMetadata(
+        name="test-scope",
+        description="Test scope",
+        tags={"env": "test"},
+    )
+    return MergedScope(
+        metadata=metadata,
+        commandments=RuleSet(categories={}),
+        suggestions=RuleSet(categories={}),
+        sources=["local"],
+    )
+
+
+@pytest.fixture
+def project_metadata_file(tmp_path):
+    """Create a temporary .project-metadata.yml with sample YAML content.
+
+    :param tmp_path: pytest tmp_path fixture
+    :returns: Path to the created .project-metadata.yml file
+    """
+    metadata_file = tmp_path / ".project-metadata.yml"
+    metadata_file.write_text(
+        "daimyo:\n"
+        "  scope: test-scope\n"
+        "language: python\n"
+        "team:\n"
+        "  lead: Alice\n"
+        "  timezone: UTC\n"
+    )
+    return metadata_file

bugyo_prjmeta-1.0.0/tests/unit/test_prjmeta_plugins.py

@@ -0,0 +1,93 @@
+"""Tests for project metadata plugin."""
+
+import pytest
+
+from bugyo_prjmeta.plugins import ProjectMetadataContextPlugin
+
+
+class TestProjectMetadataContextPlugin:
+    """Test ProjectMetadataContextPlugin functionality."""
+
+    def test_name(self):
+        """Plugin has correct name."""
+        plugin = ProjectMetadataContextPlugin()
+        assert plugin.name == "prjmeta.context"
+
+    def test_description(self):
+        """Plugin has a non-empty description."""
+        plugin = ProjectMetadataContextPlugin()
+        assert plugin.description
+
+    def test_is_available(self):
+        """Plugin is always available."""
+        plugin = ProjectMetadataContextPlugin()
+        assert plugin.is_available() is True
+
+    def test_get_context_no_file(self, tmp_path, monkeypatch, sample_merged_scope):
+        """Returns empty dict when .project-metadata.yml does not exist."""
+        monkeypatch.chdir(tmp_path)
+        plugin = ProjectMetadataContextPlugin()
+        context = plugin.get_context(sample_merged_scope)
+        assert context == {"project_metadata": {}}
+
+    def test_get_context_with_file(
+        self, tmp_path, monkeypatch, project_metadata_file, sample_merged_scope
+    ):
+        """Parses .project-metadata.yml and returns its content."""
+        monkeypatch.chdir(tmp_path)
+        plugin = ProjectMetadataContextPlugin()
+        context = plugin.get_context(sample_merged_scope)
+
+        assert "project_metadata" in context
+        data = context["project_metadata"]
+        assert data["language"] == "python"
+        assert data["daimyo"]["scope"] == "test-scope"
+
+    def test_get_context_empty_file(self, tmp_path, monkeypatch, sample_merged_scope):
+        """Returns empty dict for an empty .project-metadata.yml."""
+        monkeypatch.chdir(tmp_path)
+        (tmp_path / ".project-metadata.yml").write_text("")
+        plugin = ProjectMetadataContextPlugin()
+        context = plugin.get_context(sample_merged_scope)
+        assert context == {"project_metadata": {}}
+
+    def test_get_context_nested(self, tmp_path, monkeypatch, sample_merged_scope):
+        """Handles nested YAML structures correctly."""
+        monkeypatch.chdir(tmp_path)
+        (tmp_path / ".project-metadata.yml").write_text(
+            "team:\n"
+            "  lead: Alice\n"
+            "  members:\n"
+            "    - Bob\n"
+            "    - Charlie\n"
+        )
+        plugin = ProjectMetadataContextPlugin()
+        context = plugin.get_context(sample_merged_scope)
+
+        data = context["project_metadata"]
+        assert data["team"]["lead"] == "Alice"
+        assert data["team"]["members"] == ["Bob", "Charlie"]
+
+    @pytest.mark.parametrize(
+        ("yaml_content", "expected_key", "expected_value"),
+        [
+            ("key: value\n", "key", "value"),
+            ("number: 42\n", "number", 42),
+            ("flag: true\n", "flag", True),
+        ],
+    )
+    def test_get_context_scalar_types(
+        self,
+        tmp_path,
+        monkeypatch,
+        sample_merged_scope,
+        yaml_content,
+        expected_key,
+        expected_value,
+    ):
+        """Parses different scalar YAML types correctly."""
+        monkeypatch.chdir(tmp_path)
+        (tmp_path / ".project-metadata.yml").write_text(yaml_content)
+        plugin = ProjectMetadataContextPlugin()
+        context = plugin.get_context(sample_merged_scope)
+        assert context["project_metadata"][expected_key] == expected_value