worklog-opsdevnz 0.1.2__tar.gz → 0.2.0__tar.gz

{worklog_opsdevnz-0.1.2/src/worklog_opsdevnz.egg-info → worklog_opsdevnz-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: worklog-opsdevnz
-Version: 0.1.2
+Version: 0.2.0
 Summary: Configurable worklog management CLI for dated development logs
 Author-email: "OpsDev.nz Collective" <john@opsdev.nz>
 License: Apache-2.0
@@ -29,6 +29,7 @@ Requires-Dist: pytest-cov>=4.0; extra == "dev"
 Requires-Dist: pytest-mock>=3.10; extra == "dev"
 Requires-Dist: ruff>=0.4; extra == "dev"
 Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: zensical>=0.0.44; extra == "dev"
 Dynamic: license-file
 
 # worklog-opsdevnz
@@ -60,6 +61,7 @@ worklog_dir = "docs/worklog"
 structure = "year"           # "flat", "year", or "year-month"
 author = "Your Name"
 editor = "nvim"              # optional, overridden by -e / $VISUAL / $EDITOR
+template = "my-template.md"  # optional custom body template
 default_tags = ["worklog", "log"]
 
 [[sections]]
@@ -81,6 +83,7 @@ title = "Next"
 - Three directory structure modes: `flat`, `year`, `year-month`
 - YAML frontmatter: date, author, tags, draft status
 - Configurable section headers per project
+- Custom body templates with `{{DATE}}` and `{{TITLE}}` placeholders
 - Editor integration: `-e` flag → config → `$VISUAL` → `$EDITOR`
 - `--version` flag for installed version
 

{worklog_opsdevnz-0.1.2 → worklog_opsdevnz-0.2.0}/README.md

@@ -27,6 +27,7 @@ worklog_dir = "docs/worklog"
 structure = "year"           # "flat", "year", or "year-month"
 author = "Your Name"
 editor = "nvim"              # optional, overridden by -e / $VISUAL / $EDITOR
+template = "my-template.md"  # optional custom body template
 default_tags = ["worklog", "log"]
 
 [[sections]]
@@ -48,6 +49,7 @@ title = "Next"
 - Three directory structure modes: `flat`, `year`, `year-month`
 - YAML frontmatter: date, author, tags, draft status
 - Configurable section headers per project
+- Custom body templates with `{{DATE}}` and `{{TITLE}}` placeholders
 - Editor integration: `-e` flag → config → `$VISUAL` → `$EDITOR`
 - `--version` flag for installed version
 

{worklog_opsdevnz-0.1.2 → worklog_opsdevnz-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "worklog-opsdevnz"
-version = "0.1.2"
+version = "0.2.0"
 description = "Configurable worklog management CLI for dated development logs"
 readme = "README.md"
 license = {text = "Apache-2.0"}
@@ -37,6 +37,7 @@ dev = [
     "pytest-mock>=3.10",
     "ruff>=0.4",
     "mypy>=1.0",
+    "zensical>=0.0.44",
 ]
 
 [project.urls]

{worklog_opsdevnz-0.1.2 → worklog_opsdevnz-0.2.0}/src/worklog_opsdevnz/config.py

@@ -67,5 +67,8 @@ def get_config() -> dict[str, Any]:
         worklog_dir = merged["worklog_dir"]
         if not Path(worklog_dir).is_absolute():
             merged["worklog_dir"] = str(config_path.parent / worklog_dir)
+        template = merged.get("template")
+        if template and not Path(template).is_absolute():
+            merged["template"] = str(config_path.parent / template)
         return merged
     return dict(DEFAULT_CONFIG)

worklog_opsdevnz-0.2.0/src/worklog_opsdevnz/template.py

@@ -0,0 +1,94 @@
+"""Frontmatter and body generation for worklog entries."""
+
+from typing import Any
+
+
+def generate_frontmatter(
+    config: dict[str, Any],
+    iso_date: str,
+) -> str:
+    """Generate YAML frontmatter."""
+    title = f"Work Log - {iso_date}"
+    tags = "\n".join(f"  - {t}" for t in config.get("default_tags", []))
+    author = config.get("author", "unknown")
+
+    return f"""---
+title: "{title}"
+date: {iso_date}
+author: {author}
+tags:
+{tags}
+draft: false
+---
+"""
+
+
+def generate_body(config: dict[str, Any]) -> str:
+    """Generate section headers from config."""
+    sections = config.get("sections", [])
+    lines = []
+    for section in sections:
+        title = section.get("title", "")
+        content = section.get("content", "")
+        lines.append(f"## {title}\n")
+        if content:
+            lines.append(f"{content}\n")
+    return "\n".join(lines)
+
+
+def _render_tags(tags: list[str]) -> str:
+    """Render tags as a block-style YAML list substitution.
+
+    Empty list → '[]'. Populated list → leading newline followed by
+    each tag on its own indented line with '-' prefix.
+    """
+    if not tags:
+        return "[]"
+    return "\n" + "\n".join(f"  - {t}" for t in tags)
+
+
+def render_template(
+    template_path: str,
+    iso_date: str,
+    config: dict[str, Any],
+) -> str:
+    """Render a custom Markdown template with placeholder substitution.
+
+    Supports {{DATE}}, {{TITLE}}, {{AUTHOR}}, and {{TAGS}} placeholders.
+    All placeholders are case-sensitive.
+    """
+    title = f"Work Log - {iso_date}"
+    tags = _render_tags(config.get("default_tags", []))
+    author = config.get("author", "unknown")
+    with open(template_path) as f:
+        content = f.read()
+    content = content.replace("{{DATE}}", iso_date)
+    content = content.replace("{{TITLE}}", title)
+    content = content.replace("{{AUTHOR}}", author)
+    content = content.replace("{{TAGS}}", tags)
+    # Clean trailing whitespace (avoids artifacts when placeholder
+    # substitution leaves space before a newline, e.g. 'tags: \n')
+    content = "\n".join(line.rstrip() for line in content.split("\n"))
+    return content
+
+
+def generate_content(
+    config: dict[str, Any],
+    iso_date: str,
+) -> str:
+    """Generate full worklog content.
+
+    If a 'template' field is set in config, the template defines the
+    complete entry (including YAML frontmatter). Placeholders are
+    substituted but nothing else is prepended.
+
+    Otherwise uses the built-in default: config-driven frontmatter and
+    sections-based body.
+    """
+    template_path = config.get("template")
+    if template_path:
+        return render_template(template_path, iso_date, config)
+
+    frontmatter = generate_frontmatter(config, iso_date)
+    body = generate_body(config)
+    return f"{frontmatter}\n{body}"

{worklog_opsdevnz-0.1.2 → worklog_opsdevnz-0.2.0/src/worklog_opsdevnz.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: worklog-opsdevnz
-Version: 0.1.2
+Version: 0.2.0
 Summary: Configurable worklog management CLI for dated development logs
 Author-email: "OpsDev.nz Collective" <john@opsdev.nz>
 License: Apache-2.0
@@ -29,6 +29,7 @@ Requires-Dist: pytest-cov>=4.0; extra == "dev"
 Requires-Dist: pytest-mock>=3.10; extra == "dev"
 Requires-Dist: ruff>=0.4; extra == "dev"
 Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: zensical>=0.0.44; extra == "dev"
 Dynamic: license-file
 
 # worklog-opsdevnz
@@ -60,6 +61,7 @@ worklog_dir = "docs/worklog"
 structure = "year"           # "flat", "year", or "year-month"
 author = "Your Name"
 editor = "nvim"              # optional, overridden by -e / $VISUAL / $EDITOR
+template = "my-template.md"  # optional custom body template
 default_tags = ["worklog", "log"]
 
 [[sections]]
@@ -81,6 +83,7 @@ title = "Next"
 - Three directory structure modes: `flat`, `year`, `year-month`
 - YAML frontmatter: date, author, tags, draft status
 - Configurable section headers per project
+- Custom body templates with `{{DATE}}` and `{{TITLE}}` placeholders
 - Editor integration: `-e` flag → config → `$VISUAL` → `$EDITOR`
 - `--version` flag for installed version
 

{worklog_opsdevnz-0.1.2 → worklog_opsdevnz-0.2.0}/src/worklog_opsdevnz.egg-info/requires.txt

@@ -7,3 +7,4 @@ pytest-cov>=4.0
 pytest-mock>=3.10
 ruff>=0.4
 mypy>=1.0
+zensical>=0.0.44

worklog_opsdevnz-0.2.0/tests/test_template.py

@@ -0,0 +1,285 @@
+"""Tests for frontmatter and body generation."""
+
+import pytest
+
+from worklog_opsdevnz.template import (
+    generate_frontmatter,
+    generate_body,
+    generate_content,
+    render_template,
+)
+
+
+def test_generate_frontmatter():
+    config = {
+        "author": "Test Author",
+        "default_tags": ["internal", "test"],
+    }
+    fm = generate_frontmatter(config, "2026-05-23")
+    assert "title: " in fm
+    assert "Work Log - 2026-05-23" in fm
+    assert "date: 2026-05-23" in fm
+    assert "author: Test Author" in fm
+    assert "  - internal" in fm
+    assert "  - test" in fm
+    assert "draft: false" in fm
+    assert fm.startswith("---")
+    assert fm.strip().endswith("---")
+
+
+def test_generate_body_with_sections():
+    config = {
+        "sections": [
+            {"title": "Focus", "content": ""},
+            {"title": "Notes", "content": "some note"},
+        ]
+    }
+    body = generate_body(config)
+    assert "## Focus" in body
+    assert "## Notes" in body
+    assert "some note" in body
+
+
+def test_generate_content_full():
+    config = {
+        "author": "opsdev",
+        "default_tags": ["log"],
+        "sections": [{"title": "Today", "content": ""}],
+    }
+    content = generate_content(config, "2026-05-23")
+    assert content.startswith("---")
+    assert "Work Log - 2026-05-23" in content
+    assert "## Today" in content
+
+
+def test_render_template_with_placeholders(tmp_path):
+    template = tmp_path / "my-template.md"
+    template.write_text(
+        "---\n"
+        'title: "{{TITLE}}"\n'
+        "date: {{DATE}}\n"
+        "author: {{AUTHOR}}\n"
+        "tags: {{TAGS}}\n"
+        "draft: false\n"
+        "---\n\n"
+        "# {{TITLE}}\n\n"
+        "Date: {{DATE}}\n\n"
+        "Free-form notes."
+    )
+
+    config = {"author": "opsdev", "default_tags": ["dev", "log"]}
+    result = render_template(str(template), "2026-05-26", config)
+
+    # Placeholders replaced
+    assert "{{DATE}}" not in result
+    assert "{{TITLE}}" not in result
+    assert "{{AUTHOR}}" not in result
+    assert "{{TAGS}}" not in result
+
+    # Content verified
+    assert "# Work Log - 2026-05-26" in result
+    assert "Date: 2026-05-26" in result
+    assert "Free-form notes." in result
+    assert 'title: "Work Log - 2026-05-26"' in result
+    assert "date: 2026-05-26" in result
+    assert "author: opsdev" in result
+    assert "draft: false" in result
+
+    # Tags rendered as block-style YAML
+    assert "  - dev" in result
+    assert "  - log" in result
+
+
+def test_render_template_file_not_found():
+    with pytest.raises(FileNotFoundError):
+        render_template("/nonexistent/template.md", "2026-05-26", {})
+
+
+def test_generate_content_with_template(tmp_path):
+    """When template is set, it defines the complete entry.
+    
+    No auto-generated frontmatter is prepended.
+    """
+    template = tmp_path / "my-template.md"
+    template.write_text(
+        "---\n"
+        'title: "{{TITLE}}"\n'
+        "date: {{DATE}}\n"
+        "author: {{AUTHOR}}\n"
+        "tags: {{TAGS}}\n"
+        "draft: false\n"
+        "---\n\n"
+        "# {{TITLE}}\n\n"
+        "Date: {{DATE}}"
+    )
+
+    config = {
+        "author": "opsdev",
+        "default_tags": ["log"],
+        "template": str(template),
+    }
+    content = generate_content(config, "2026-05-26")
+
+    # Template defines the full entry — its frontmatter is present
+    assert content.startswith("---")
+    assert 'title: "Work Log - 2026-05-26"' in content
+    assert "date: 2026-05-26" in content
+    assert "author: opsdev" in content
+    assert "  - log" in content
+    assert "draft: false" in content
+
+    # Body comes from template
+    assert "# Work Log - 2026-05-26" in content
+    assert "Date: 2026-05-26" in content
+
+    # No duplicate frontmatter — only one '---' block
+    assert content.count("---") == 2  # opening + closing
+
+    # Sections are NOT present (template controls everything)
+    assert "## Focus for Today" not in content
+
+
+def test_generate_content_without_template():
+    """No template field → built-in sections body, unchanged behaviour."""
+    config = {
+        "author": "opsdev",
+        "default_tags": ["log"],
+        "sections": [{"title": "Today", "content": ""}],
+    }
+    content = generate_content(config, "2026-05-26")
+    assert "## Today" in content
+
+
+# ── {{TAGS}} rendering ────────────────────────────────────────────
+
+
+def test_render_template_tags_empty(tmp_path):
+    """Empty default_tags → {{TAGS}} substitutes as '[]'."""
+    template = tmp_path / "t.md"
+    template.write_text("tags: {{TAGS}}\n")
+
+    result = render_template(str(template), "2026-06-01", {"default_tags": []})
+    assert "tags: []" in result
+    assert "{{TAGS}}" not in result
+
+
+def test_render_template_tags_populated(tmp_path):
+    """Populated default_tags → {{TAGS}} renders as block-style YAML list."""
+    template = tmp_path / "t.md"
+    template.write_text("tags: {{TAGS}}\n")
+
+    config = {"default_tags": ["dev", "log", "ops"]}
+    result = render_template(str(template), "2026-06-01", config)
+
+    # Block-style: leading newline + indented items, no trailing whitespace
+    assert "tags:\n  - dev\n  - log\n  - ops" in result
+    assert "{{TAGS}}" not in result
+
+
+def test_render_template_tags_not_configured(tmp_path):
+    """No default_tags in config → {{TAGS}} substitutes as '[]'."""
+    template = tmp_path / "t.md"
+    template.write_text("tags: {{TAGS}}\n")
+
+    result = render_template(str(template), "2026-06-01", {})
+    assert "tags: []" in result
+
+
+# ── {{AUTHOR}} rendering ──────────────────────────────────────────
+
+
+def test_render_template_author_configured(tmp_path):
+    """{{AUTHOR}} pulls the author value from config."""
+    template = tmp_path / "t.md"
+    template.write_text("author: {{AUTHOR}}\n")
+
+    result = render_template(str(template), "2026-06-01", {"author": "opsdev"})
+    assert "author: opsdev" in result
+    assert "{{AUTHOR}}" not in result
+
+
+def test_render_template_author_fallback(tmp_path):
+    """{{AUTHOR}} falls back to 'unknown' when not in config."""
+    template = tmp_path / "t.md"
+    template.write_text("author: {{AUTHOR}}\n")
+
+    result = render_template(str(template), "2026-06-01", {})
+    assert "author: unknown" in result
+
+
+# ── Full-entry template edge cases ────────────────────────────────
+
+
+def test_generate_content_template_defines_full_entry(tmp_path):
+    """Template with custom YAML fields — the tool only substitutes placeholders."""
+    template = tmp_path / "custom.md"
+    template.write_text(
+        "---\n"
+        'title: "{{TITLE}}"\n'
+        "date: {{DATE}}\n"
+        "author: {{AUTHOR}}\n"
+        "tags: {{TAGS}}\n"
+        "mood: creative\n"
+        "project: outcome-engineering\n"
+        "draft: false\n"
+        "---\n\n"
+        "# {{TITLE}}\n\n"
+        "Custom body content."
+    )
+
+    config = {
+        "author": "opsdev",
+        "default_tags": ["dev"],
+        "template": str(template),
+    }
+    content = generate_content(config, "2026-06-05")
+
+    # Custom fields preserved verbatim
+    assert "mood: creative" in content
+    assert "project: outcome-engineering" in content
+
+    # Placeholders substituted
+    assert 'title: "Work Log - 2026-06-05"' in content
+    assert "date: 2026-06-05" in content
+    assert "author: opsdev" in content
+    assert "  - dev" in content
+
+    # Body preserved
+    assert "Custom body content." in content
+
+    # No auto-generated frontmatter prepended
+    assert content.count("---") == 2  # only the template's opening/closing
+
+
+def test_generate_content_template_no_frontmatter(tmp_path):
+    """Template without frontmatter — entry has no frontmatter at all."""
+    template = tmp_path / "body-only.md"
+    template.write_text("# {{TITLE}}\n\nJust body content.")
+
+    config = {"template": str(template)}
+    content = generate_content(config, "2026-06-05")
+
+    # No frontmatter markers, just the rendered template
+    assert "---" not in content
+    assert "# Work Log - 2026-06-05" in content
+    assert "Just body content." in content
+
+
+def test_render_template_case_sensitive(tmp_path):
+    """Lowercase placeholders are NOT substituted."""
+    template = tmp_path / "t.md"
+    template.write_text(
+        "title: {{title}}\n"
+        "date: {{date}}\n"
+        "author: {{author}}\n"
+        "tags: {{tags}}\n"
+    )
+
+    config = {"author": "opsdev", "default_tags": ["dev"]}
+    result = render_template(str(template), "2026-06-05", config)
+
+    # Lowercase placeholders left untouched
+    assert "{{title}}" in result
+    assert "{{date}}" in result
+    assert "{{author}}" in result
+    assert "{{tags}}" in result

worklog_opsdevnz-0.1.2/src/worklog_opsdevnz/template.py

@@ -1,46 +0,0 @@
-"""Frontmatter and body generation for worklog entries."""
-
-from typing import Any
-
-
-def generate_frontmatter(
-    config: dict[str, Any],
-    iso_date: str,
-) -> str:
-    """Generate YAML frontmatter."""
-    title = f"Work Log - {iso_date}"
-    tags = "\n".join(f"  - {t}" for t in config.get("default_tags", []))
-    author = config.get("author", "unknown")
-
-    return f"""---
-title: "{title}"
-date: {iso_date}
-author: {author}
-tags:
-{tags}
-draft: false
----
-"""
-
-
-def generate_body(config: dict[str, Any]) -> str:
-    """Generate section headers from config."""
-    sections = config.get("sections", [])
-    lines = []
-    for section in sections:
-        title = section.get("title", "")
-        content = section.get("content", "")
-        lines.append(f"## {title}\n")
-        if content:
-            lines.append(f"{content}\n")
-    return "\n".join(lines)
-
-
-def generate_content(
-    config: dict[str, Any],
-    iso_date: str,
-) -> str:
-    """Generate full worklog content."""
-    frontmatter = generate_frontmatter(config, iso_date)
-    body = generate_body(config)
-    return f"{frontmatter}\n{body}"

worklog_opsdevnz-0.1.2/tests/test_template.py

@@ -1,45 +0,0 @@
-"""Tests for frontmatter and body generation."""
-
-from worklog_opsdevnz.template import generate_frontmatter, generate_body, generate_content
-
-
-def test_generate_frontmatter():
-    config = {
-        "author": "Test Author",
-        "default_tags": ["internal", "test"],
-    }
-    fm = generate_frontmatter(config, "2026-05-23")
-    assert "title: " in fm
-    assert "Work Log - 2026-05-23" in fm
-    assert "date: 2026-05-23" in fm
-    assert "author: Test Author" in fm
-    assert "  - internal" in fm
-    assert "  - test" in fm
-    assert "draft: false" in fm
-    assert fm.startswith("---")
-    assert fm.strip().endswith("---")
-
-
-def test_generate_body_with_sections():
-    config = {
-        "sections": [
-            {"title": "Focus", "content": ""},
-            {"title": "Notes", "content": "some note"},
-        ]
-    }
-    body = generate_body(config)
-    assert "## Focus" in body
-    assert "## Notes" in body
-    assert "some note" in body
-
-
-def test_generate_content_full():
-    config = {
-        "author": "opsdev",
-        "default_tags": ["log"],
-        "sections": [{"title": "Today", "content": ""}],
-    }
-    content = generate_content(config, "2026-05-23")
-    assert content.startswith("---")
-    assert "Work Log - 2026-05-23" in content
-    assert "## Today" in content