worklog-opsdevnz 0.1.0__tar.gz → 0.1.1__tar.gz

{worklog_opsdevnz-0.1.0 → worklog_opsdevnz-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: worklog-opsdevnz
-Version: 0.1.0
+Version: 0.1.1
 Summary: Configurable worklog management CLI for dated development logs
 Author-email: "OpsDev.nz Collective" <john@opsdev.nz>
 License: Apache-2.0
@@ -31,41 +31,21 @@ Requires-Dist: ruff>=0.4; extra == "dev"
 Requires-Dist: mypy>=1.0; extra == "dev"
 Dynamic: license-file
 
-# WorkLog OpsDev.NZ
-
-**Status:** Development — see pyproject.toml for version
+# worklog-opsdevnz
 
 Configurable CLI tool for creating and managing dated development worklogs.
 Generates Markdown entries with YAML frontmatter from per-project templates.
 
-## Problem
-
-Across multiple projects we kept reinventing the same pattern: a script that
-creates a dated Markdown file from a template, with frontmatter for date,
-author, tags, and draft status.  Each implementation had slightly different
-directory structures, section headers, and filenames. The core concept was
-always the same.
-
-## Solution
-
-`worklog-opsdevnz` formalises this pattern into a single published module:
-
-- **Per-project config** — `worklog.toml` controls directory structure, sections,
-  author, tags, and filename patterns
-- **Three structure modes** — `flat`, `year`, or `year-month` directory layouts
-- **YAML frontmatter** — date, title, author, tags, draft status
-- **Configurable sections** — each project defines its own section headers
-- **Editor integration** — opens new entries in `$VISUAL` / `$EDITOR`
-- **List existing entries** — browse worklogs with `--list`
-
 ## Quick Start
 
 ```bash
+pip install worklog-opsdevnz
+
 # Create today's worklog
 worklog-opsdevnz
 
-# Create yesterday's worklog
-worklog-opsdevnz --previous
+# Show installed version
+worklog-opsdevnz --version
 
 # Override the editor for this run
 worklog-opsdevnz --editor nvim
@@ -79,6 +59,7 @@ Each project gets a `worklog.toml` at its root:
 worklog_dir = "docs/worklog"
 structure = "year"           # "flat", "year", or "year-month"
 author = "Your Name"
+editor = "nvim"              # optional, overridden by -e / $VISUAL / $EDITOR
 default_tags = ["worklog", "log"]
 
 [[sections]]
@@ -94,34 +75,30 @@ title = "Notes"
 title = "Next"
 ```
 
-## Scope
+## Features
 
-**WorkLog DOES:**
-- Create dated Markdown worklog entries with YAML frontmatter
 - Per-project configuration via `worklog.toml`
-- Open entries in configured editor (`$VISUAL` / `$EDITOR`)
-- Three directory structure modes: flat, year, year-month
-
-**WorkLog DOES NOT (out of scope for 0.0.2):**
-- Zensical blog integration (see design doc)
-- Auto-generated index pages
-- Retro template support (planned for 0.1.0)
-- Time tracking / timesheet aggregation
-- `list`, `init`, or `create` subcommands (planned for 0.1.0)
+- Three directory structure modes: `flat`, `year`, `year-month`
+- YAML frontmatter: date, author, tags, draft status
+- Configurable section headers per project
+- Editor integration: `-e` flag → config → `$VISUAL` → `$EDITOR`
+- `--version` flag for installed version
 
 ## Requirements
 
 - Python 3.12+
 - See [pyproject.toml](pyproject.toml) for full dependencies
 
-## Related
+## Documentation
 
+- [Release Process](docs/release-process.md)
 - [Functional Requirements](docs/specs/README.md)
+- [Non-Functional Requirements](docs/specs/NFR.md)
 - [Design Decisions](docs/design/README.md)
 - [User Stories](docs/stories/README.md)
 
----
+## Related
 
-**Last Updated:** 2026-05-23
-**Status:** Development (migrated to module template)
-**Maintainer:** OpsDev.nz Collective
+- [PyPI](https://pypi.org/project/worklog-opsdevnz/)
+- [GitHub](https://github.com/startmeup-nz/worklog_opsdevnz)
+- [OpsDev.nz Collective](https://opsdev.nz)

worklog_opsdevnz-0.1.1/README.md

@@ -0,0 +1,71 @@
+# worklog-opsdevnz
+
+Configurable CLI tool for creating and managing dated development worklogs.
+Generates Markdown entries with YAML frontmatter from per-project templates.
+
+## Quick Start
+
+```bash
+pip install worklog-opsdevnz
+
+# Create today's worklog
+worklog-opsdevnz
+
+# Show installed version
+worklog-opsdevnz --version
+
+# Override the editor for this run
+worklog-opsdevnz --editor nvim
+```
+
+## Configuration
+
+Each project gets a `worklog.toml` at its root:
+
+```toml
+worklog_dir = "docs/worklog"
+structure = "year"           # "flat", "year", or "year-month"
+author = "Your Name"
+editor = "nvim"              # optional, overridden by -e / $VISUAL / $EDITOR
+default_tags = ["worklog", "log"]
+
+[[sections]]
+title = "Focus for Today"
+
+[[sections]]
+title = "Completed"
+
+[[sections]]
+title = "Notes"
+
+[[sections]]
+title = "Next"
+```
+
+## Features
+
+- Per-project configuration via `worklog.toml`
+- Three directory structure modes: `flat`, `year`, `year-month`
+- YAML frontmatter: date, author, tags, draft status
+- Configurable section headers per project
+- Editor integration: `-e` flag → config → `$VISUAL` → `$EDITOR`
+- `--version` flag for installed version
+
+## Requirements
+
+- Python 3.12+
+- See [pyproject.toml](pyproject.toml) for full dependencies
+
+## Documentation
+
+- [Release Process](docs/release-process.md)
+- [Functional Requirements](docs/specs/README.md)
+- [Non-Functional Requirements](docs/specs/NFR.md)
+- [Design Decisions](docs/design/README.md)
+- [User Stories](docs/stories/README.md)
+
+## Related
+
+- [PyPI](https://pypi.org/project/worklog-opsdevnz/)
+- [GitHub](https://github.com/startmeup-nz/worklog_opsdevnz)
+- [OpsDev.nz Collective](https://opsdev.nz)

{worklog_opsdevnz-0.1.0 → worklog_opsdevnz-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "worklog-opsdevnz"
-version = "0.1.0"
+version = "0.1.1"
 description = "Configurable worklog management CLI for dated development logs"
 readme = "README.md"
 license = {text = "Apache-2.0"}

{worklog_opsdevnz-0.1.0 → worklog_opsdevnz-0.1.1}/src/worklog_opsdevnz/cli.py

@@ -19,7 +19,7 @@ from worklog_opsdevnz.template import generate_content
     "-e",
     "--editor",
     default=None,
-    help="Override the editor command (default: $VISUAL or $EDITOR).",
+    help="Override the editor command (overrides config, $VISUAL, $EDITOR).",
 )
 def main(editor: str | None) -> None:
     """Create or open today's worklog entry."""
@@ -36,12 +36,12 @@ def main(editor: str | None) -> None:
         target.write_text(content)
         print(f"Created: {target}")
 
-    _open_editor(target, editor)
+    _open_editor(target, editor, config.get("editor"))
 
 
-def _open_editor(path: str | Path, override: str | None = None) -> None:
+def _open_editor(path: str | Path, override: str | None = None, config_editor: str | None = None) -> None:
     """Open the file in the configured editor, or print the path."""
-    editor = _resolve_editor(override)
+    editor = _resolve_editor(override, config_editor)
     if editor:
         editor_cmd = shutil.which(editor)
         if editor_cmd:
@@ -54,11 +54,11 @@ def _open_editor(path: str | Path, override: str | None = None) -> None:
         print(f"No editor configured. Path: {path}")
 
 
-def _resolve_editor(override: str | None = None) -> str | None:
-    """Resolve editor from CLI override, $VISUAL, or $EDITOR."""
+def _resolve_editor(override: str | None = None, config_editor: str | None = None) -> str | None:
+    """Resolve editor from CLI, config, $VISUAL, or $EDITOR."""
     import os
 
-    for candidate in (override, os.environ.get("VISUAL"), os.environ.get("EDITOR")):
+    for candidate in (override, config_editor, os.environ.get("VISUAL"), os.environ.get("EDITOR")):
         if candidate:
             return candidate
     return None

{worklog_opsdevnz-0.1.0 → worklog_opsdevnz-0.1.1}/src/worklog_opsdevnz.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: worklog-opsdevnz
-Version: 0.1.0
+Version: 0.1.1
 Summary: Configurable worklog management CLI for dated development logs
 Author-email: "OpsDev.nz Collective" <john@opsdev.nz>
 License: Apache-2.0
@@ -31,41 +31,21 @@ Requires-Dist: ruff>=0.4; extra == "dev"
 Requires-Dist: mypy>=1.0; extra == "dev"
 Dynamic: license-file
 
-# WorkLog OpsDev.NZ
-
-**Status:** Development — see pyproject.toml for version
+# worklog-opsdevnz
 
 Configurable CLI tool for creating and managing dated development worklogs.
 Generates Markdown entries with YAML frontmatter from per-project templates.
 
-## Problem
-
-Across multiple projects we kept reinventing the same pattern: a script that
-creates a dated Markdown file from a template, with frontmatter for date,
-author, tags, and draft status.  Each implementation had slightly different
-directory structures, section headers, and filenames. The core concept was
-always the same.
-
-## Solution
-
-`worklog-opsdevnz` formalises this pattern into a single published module:
-
-- **Per-project config** — `worklog.toml` controls directory structure, sections,
-  author, tags, and filename patterns
-- **Three structure modes** — `flat`, `year`, or `year-month` directory layouts
-- **YAML frontmatter** — date, title, author, tags, draft status
-- **Configurable sections** — each project defines its own section headers
-- **Editor integration** — opens new entries in `$VISUAL` / `$EDITOR`
-- **List existing entries** — browse worklogs with `--list`
-
 ## Quick Start
 
 ```bash
+pip install worklog-opsdevnz
+
 # Create today's worklog
 worklog-opsdevnz
 
-# Create yesterday's worklog
-worklog-opsdevnz --previous
+# Show installed version
+worklog-opsdevnz --version
 
 # Override the editor for this run
 worklog-opsdevnz --editor nvim
@@ -79,6 +59,7 @@ Each project gets a `worklog.toml` at its root:
 worklog_dir = "docs/worklog"
 structure = "year"           # "flat", "year", or "year-month"
 author = "Your Name"
+editor = "nvim"              # optional, overridden by -e / $VISUAL / $EDITOR
 default_tags = ["worklog", "log"]
 
 [[sections]]
@@ -94,34 +75,30 @@ title = "Notes"
 title = "Next"
 ```
 
-## Scope
+## Features
 
-**WorkLog DOES:**
-- Create dated Markdown worklog entries with YAML frontmatter
 - Per-project configuration via `worklog.toml`
-- Open entries in configured editor (`$VISUAL` / `$EDITOR`)
-- Three directory structure modes: flat, year, year-month
-
-**WorkLog DOES NOT (out of scope for 0.0.2):**
-- Zensical blog integration (see design doc)
-- Auto-generated index pages
-- Retro template support (planned for 0.1.0)
-- Time tracking / timesheet aggregation
-- `list`, `init`, or `create` subcommands (planned for 0.1.0)
+- Three directory structure modes: `flat`, `year`, `year-month`
+- YAML frontmatter: date, author, tags, draft status
+- Configurable section headers per project
+- Editor integration: `-e` flag → config → `$VISUAL` → `$EDITOR`
+- `--version` flag for installed version
 
 ## Requirements
 
 - Python 3.12+
 - See [pyproject.toml](pyproject.toml) for full dependencies
 
-## Related
+## Documentation
 
+- [Release Process](docs/release-process.md)
 - [Functional Requirements](docs/specs/README.md)
+- [Non-Functional Requirements](docs/specs/NFR.md)
 - [Design Decisions](docs/design/README.md)
 - [User Stories](docs/stories/README.md)
 
----
+## Related
 
-**Last Updated:** 2026-05-23
-**Status:** Development (migrated to module template)
-**Maintainer:** OpsDev.nz Collective
+- [PyPI](https://pypi.org/project/worklog-opsdevnz/)
+- [GitHub](https://github.com/startmeup-nz/worklog_opsdevnz)
+- [OpsDev.nz Collective](https://opsdev.nz)

{worklog_opsdevnz-0.1.0 → worklog_opsdevnz-0.1.1}/tests/test_cli.py

@@ -47,3 +47,25 @@ def test_main_version():
     # Extract and verify it's a non-empty version string
     version_str = result.output.strip().split(", version ")[-1]
     assert version_str
+
+
+def test_main_editor_from_config(tmp_path, monkeypatch):
+    """Editor in worklog.toml is resolved before $VISUAL/$EDITOR."""
+    monkeypatch.chdir(tmp_path)
+    (tmp_path / "worklog.toml").write_text('editor = "fake-editor-test"\n')
+    runner = CliRunner()
+    result = runner.invoke(main, [])
+    assert result.exit_code == 0
+    # config-based editor picked up but not found in PATH
+    assert "Editor 'fake-editor-test' not found" in result.output
+
+
+def test_main_editor_cli_overrides_config(tmp_path, monkeypatch):
+    """-e flag overrides the editor set in worklog.toml."""
+    monkeypatch.chdir(tmp_path)
+    (tmp_path / "worklog.toml").write_text('editor = "fake-editor-test"\n')
+    runner = CliRunner()
+    result = runner.invoke(main, ["-e", "override-editor-test"])
+    assert result.exit_code == 0
+    # CLI override takes priority over config
+    assert "Editor 'override-editor-test' not found" in result.output

worklog_opsdevnz-0.1.0/README.md

@@ -1,94 +0,0 @@
-# WorkLog OpsDev.NZ
-
-**Status:** Development — see pyproject.toml for version
-
-Configurable CLI tool for creating and managing dated development worklogs.
-Generates Markdown entries with YAML frontmatter from per-project templates.
-
-## Problem
-
-Across multiple projects we kept reinventing the same pattern: a script that
-creates a dated Markdown file from a template, with frontmatter for date,
-author, tags, and draft status.  Each implementation had slightly different
-directory structures, section headers, and filenames. The core concept was
-always the same.
-
-## Solution
-
-`worklog-opsdevnz` formalises this pattern into a single published module:
-
-- **Per-project config** — `worklog.toml` controls directory structure, sections,
-  author, tags, and filename patterns
-- **Three structure modes** — `flat`, `year`, or `year-month` directory layouts
-- **YAML frontmatter** — date, title, author, tags, draft status
-- **Configurable sections** — each project defines its own section headers
-- **Editor integration** — opens new entries in `$VISUAL` / `$EDITOR`
-- **List existing entries** — browse worklogs with `--list`
-
-## Quick Start
-
-```bash
-# Create today's worklog
-worklog-opsdevnz
-
-# Create yesterday's worklog
-worklog-opsdevnz --previous
-
-# Override the editor for this run
-worklog-opsdevnz --editor nvim
-```
-
-## Configuration
-
-Each project gets a `worklog.toml` at its root:
-
-```toml
-worklog_dir = "docs/worklog"
-structure = "year"           # "flat", "year", or "year-month"
-author = "Your Name"
-default_tags = ["worklog", "log"]
-
-[[sections]]
-title = "Focus for Today"
-
-[[sections]]
-title = "Completed"
-
-[[sections]]
-title = "Notes"
-
-[[sections]]
-title = "Next"
-```
-
-## Scope
-
-**WorkLog DOES:**
-- Create dated Markdown worklog entries with YAML frontmatter
-- Per-project configuration via `worklog.toml`
-- Open entries in configured editor (`$VISUAL` / `$EDITOR`)
-- Three directory structure modes: flat, year, year-month
-
-**WorkLog DOES NOT (out of scope for 0.0.2):**
-- Zensical blog integration (see design doc)
-- Auto-generated index pages
-- Retro template support (planned for 0.1.0)
-- Time tracking / timesheet aggregation
-- `list`, `init`, or `create` subcommands (planned for 0.1.0)
-
-## Requirements
-
-- Python 3.12+
-- See [pyproject.toml](pyproject.toml) for full dependencies
-
-## Related
-
-- [Functional Requirements](docs/specs/README.md)
-- [Design Decisions](docs/design/README.md)
-- [User Stories](docs/stories/README.md)
-
----
-
-**Last Updated:** 2026-05-23
-**Status:** Development (migrated to module template)
-**Maintainer:** OpsDev.nz Collective