pyworklog 0.3.0__py3-none-any.whl

pyworklog-0.3.0.dist-info/METADATA

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: pyworklog
+Version: 0.3.0
+Summary: SQLite-backed worklog tool with a todo.sh-style CLI
+Project-URL: Homepage, https://github.com/xyb/worklog
+Project-URL: Repository, https://github.com/xyb/worklog
+Project-URL: Issues, https://github.com/xyb/worklog/issues
+Author: Xie Yanbo
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,productivity,sqlite,todo,worklog
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: rich>=13
+Description-Content-Type: text/markdown
+
+<sub><b>🌐 English</b> · <a href="README.zh.md">中文</a></sub>
+
+# worklog
+
+[![Test](https://github.com/xyb/worklog/actions/workflows/test.yml/badge.svg)](https://github.com/xyb/worklog/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/xyb/worklog/branch/main/graph/badge.svg)](https://codecov.io/gh/xyb/worklog)
+
+> **Changelog**: see [CHANGELOG.md](CHANGELOG.md) for a curated highlight reel of every release.
+
+SQLite-backed worklog tool with a `todo.sh`-style CLI. Models the full execution-system hierarchy in a single `node` table — lifetime / decade / year / quarter / month / week / day / project / task / habit / signal / meetlog — all sharing one id space, tree-linked via `parent_id` self-reference.
+
+**Design conventions: see [DESIGN.md](DESIGN.md)** — required reading before adding commands, to keep everything consistent.
+**AI collaboration: see [skills/worklog-cli/SKILL.md](skills/worklog-cli/SKILL.md)** — Claude Code skill (when / how to use `wl`, plus bulk import / apply).
+Background: structured worklog tool, built as a self-built alternative after surveying 12 candidate products (Logseq / Tana / TaskWarrior / org-mode / Anytype / Capacities / Linear etc.) and finding no off-the-shelf tool that fits all three dimensions (time hierarchy, project hierarchy, vault wikilink) without compromise.
+
+## Install
+
+### From PyPI (recommended for users)
+
+```fish
+pipx install pyworklog          # or: uv tool install pyworklog
+wl init
+```
+
+The PyPI distribution name is `pyworklog` (the short names `worklog` and `worklog-cli` were already taken, and hyphenated names like `worklog-py` were avoided); the command stays `wl` and the import name stays `worklog`.
+
+### From source (recommended for development)
+
+Requires [uv](https://docs.astral.sh/uv/) (`brew install uv` or `pipx install uv`).
+
+```fish
+git clone https://github.com/xyb/worklog.git ~/projects/worklog
+cd ~/projects/worklog
+make setup       # uv sync + install ~/bin/wl wrapper
+
+# shell completion (init-load mode, pick your shell)
+# fish: add to ~/.config/fish/config.fish
+echo 'wl print-completion fish | source' >> ~/.config/fish/config.fish
+# bash: add to ~/.bashrc       →  eval "$(wl print-completion bash)"
+# zsh:  add to ~/.zshrc        →  eval "$(wl print-completion zsh)"
+
+wl init
+```
+
+Behind the scenes `make setup` runs `uv sync` to create `.venv/` from `pyproject.toml` + `uv.lock`, then installs a `~/bin/wl` wrapper pointing into that `.venv`.
+
+DB location follows the [XDG Base Directory spec](https://specifications.freedesktop.org/basedir-spec/): default `$XDG_DATA_HOME/worklog/worklog.db` (i.e. `~/.local/share/worklog/worklog.db`). Override per-invocation with `wl --db PATH ...`, or globally with the `$WORKLOG_DB` env var. User config (aliases.ini) lives at `$XDG_CONFIG_HOME/worklog/aliases.ini` (default `~/.config/worklog/aliases.ini`).
+
+## Commands
+
+```fish
+wl add "research X" -k task -p A -t work,P0 --proj dev_tooling --parent 42
+wl add "Dev tooling" -k project -p A --parent 4   # project hangs under month
+wl log 42 "reviewed A's material, found..."
+wl done 42
+wl defer 42 2026-06-01
+wl start 42 ; wl stop 42                            # CLOCK in/out
+wl link 42 "Dev tooling"                       # vault wikilink
+wl set 42 owner xyb                               # custom prop
+wl show 42                                          # detail + log + tags + links
+wl ls                                               # default: list open items
+wl ls --kind project --tag work,P0
+wl tree                                             # full tree
+wl tree --kind year --depth 3
+wl logs --since 2026-05-18                          # cross-task log range query
+wl find needle                                      # full-text search, matches highlighted + indented
+```
+
+### Highlighting / colors
+
+Terminal output is colored by default (via `rich`); global flags go before the subcommand:
+
+```fish
+wl themes                            # list dark/light/mono themes + previews + mark current
+wl --color always tree | less -R     # force color (preserves ANSI through pipes)
+wl --color never ls                  # no color (plain text)
+wl --theme light summary --week ...  # manually pick the light-background theme
+```
+
+- `--color {auto,always,never}`, default `auto`: colors on if TTY + rich available; pipes / redirects / no-rich downgrade to plain text
+- `--theme {auto,dark,light,mono}`, default **auto**: probes terminal background and picks dark (dark bg) / light (light bg); falls back to dark when undetectable. dark/light/mono can also be picked manually.
+  - Background probe: first checks `$COLORFGBG`, then sends an OSC 11 query (needs an interactive terminal, short timeout, gracefully falls back if unsupported)
+- Search hits (including matches in titles) highlight: styled mode uses background color; plain text wraps with `*…*`
+- env fallback: `$WORKLOG_COLOR` / `$WORKLOG_THEME` / `$NO_COLOR`
+- `rich` is an optional dependency — the tool still runs without it (plain text only)
+
+## Schema
+
+Six tables; everything is a `node`.
+
+```
+node (id, parent_id→node, title, kind, status, priority,
+      created_at, scheduled_at, deadline_at, closed_at, body)
+tag  (node_id→node, tag)                    # many-to-many
+log  (id, node_id→node, logged_at, body)    # one node, many log entries
+prop (node_id→node, key, value)             # UDA
+link (node_id→node, vault_doc)              # vault wikilink
+v_node_path                                  # recursive CTE view, tree path
+```
+
+The `kind` field lets one table hold any execution-system entity. Cascade delete propagates to `tag/log/prop/link`; `parent_id` uses `ON DELETE SET NULL` so deleting a parent doesn't orphan-kill children.
+
+## Status states
+
+`TODO / DOING / LATER / WAIT / DONE / DEFERRED / CANCELED` — superset of the markdown `[ ]/[x]/[/]/[>]` four-state set, adds `LATER` / `WAIT` distinction (deferred to future vs. waiting on someone).
+
+## Contributing
+
+Development setup, the TDD/DRY conventions, local Makefile overrides, and the release process all live in [CONTRIBUTING.md](CONTRIBUTING.md). For agent-facing operating rules see [AGENTS.md](AGENTS.md); for canonical design conventions see [DESIGN.md](DESIGN.md).

pyworklog-0.3.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+worklog/__init__.py,sha256=4ICaqcHAxO1wPjM9HVb6ttTaHTcn04aFZXefMLg6E5U,247
+worklog/cli.py,sha256=ab8wNTziONT-zzTd-mDalp06kkStt6N3rwFWyzBS3FU,58266
+worklog/completion.py,sha256=QaBeVzxtV6IBwEtls2VdF9goZQPYdQZyA2bKwpXPNss,24819
+worklog/db.py,sha256=fGg-h13VGXM0rSwTSsmT_4GZxxaxy_E2-XgZWPcWF3o,3417
+worklog/helpers.py,sha256=klxqMHootwhSwClovEk4kjFaaml21t-havTp1iel3pQ,10792
+worklog/queries.py,sha256=yvnQ-q6q8D7EtCqP4nv2OyYWb_GctaN62hsmKMtGXW8,8949
+worklog/render.py,sha256=ie6I1RtOotsaYPnXpwLp5wzr4OvxKuOnfpnvH92E7ic,8775
+worklog/xdg.py,sha256=nNth78n274F5GjpTbZYZa-Q5x_jIf2So0ZpqtgIfMvU,1424
+worklog/commands/__init__.py,sha256=J7Pbhe-4sPbpq68pIaU08TQCKCigdMt51RKZDSkBqPQ,1750
+worklog/commands/bulk.py,sha256=M2gWISXC3btSGItdEK1kut-48YZ06OssT82KGMR0a98,20962
+worklog/commands/meta.py,sha256=3nxAVZWAoQm0egZNZzFt3ofg_intWO2cMH4Xu8NKREU,24116
+worklog/commands/query.py,sha256=YmextEfM6dfh3OwILqYnfaXmkSH5r9uX7nhOkIX1nEs,36494
+worklog/commands/state.py,sha256=u9v4mYPM71oWrBrLzA37fQNi_aGqjohErbT4WWAJNY8,26235
+worklog/commands/views.py,sha256=0O-rNey3y6-5su0uvVsZLjau6AYhjzmUfwpGJuz5gnc,24668
+worklog/migrations/0001_initial_schema.sql,sha256=bsHyhRdTA4xhpMhI7NlSs6QXWOraflQjEHKEiorky2Y,4107
+pyworklog-0.3.0.dist-info/METADATA,sha256=zmN0R6_uihdNy6c_LmNK9tSs6NHhrhaSszuNfvBKvTA,7247
+pyworklog-0.3.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+pyworklog-0.3.0.dist-info/entry_points.txt,sha256=8fLnAvKY2dWuKkOENDr18v9KmWXpyR3Pbne839YaRh8,40
+pyworklog-0.3.0.dist-info/licenses/LICENSE,sha256=YQPkgwT6XnCSanK6orDJXISLrE12O3MxulsDivd4ELg,1066
+pyworklog-0.3.0.dist-info/RECORD,,

pyworklog-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pyworklog-0.3.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+wl = worklog.cli:main

pyworklog-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Xie Yanbo
+
+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.

worklog/__init__.py

@@ -0,0 +1,8 @@
+"""worklog: SQLite-backed worklog tool with a todo.sh-style CLI.
+
+The CLI entry point is `worklog.cli:main`, exposed as the `wl` console
+script (see [project.scripts] in pyproject.toml).
+"""
+from .cli import __version__
+
+__all__ = ["__version__"]