Metadata-Version: 2.4
Name: worklog-opsdevnz
Version: 0.1.2
Summary: Configurable worklog management CLI for dated development logs
Author-email: "OpsDev.nz Collective" <john@opsdev.nz>
License: Apache-2.0
Project-URL: Homepage, https://github.com/startmeup-nz/worklog-opsdevnz
Project-URL: Documentation, https://opsdev.nz/modules/worklog-opsdevnz
Project-URL: Repository, https://github.com/startmeup-nz/worklog-opsdevnz.git
Project-URL: Bug Tracker, https://github.com/startmeup-nz/worklog-opsdevnz/issues
Keywords: worklog,documentation,daily-log,cli,markdown
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: Markdown
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.0
Requires-Dist: pyyaml>=6.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
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"
Dynamic: license-file

# 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)
