worklogs 0.1.0__py3-none-any.whl

worklogs/__init__.py

@@ -0,0 +1,7 @@
+"""Worklog file helpers."""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+__all__ = ["__version__"]

worklogs/cli.py

@@ -0,0 +1,31 @@
+"""Command-line entry point for worklogs."""
+
+from __future__ import annotations
+
+import argparse
+from typing import TYPE_CHECKING
+
+from worklogs import __version__
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+
+def build_parser() -> argparse.ArgumentParser:
+    """Build the command-line parser."""
+    parser = argparse.ArgumentParser(
+        prog="worklogs",
+        description="Create and maintain local worklog files.",
+    )
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s {__version__}",
+    )
+    return parser
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    """Run the worklogs command-line interface."""
+    build_parser().parse_args(argv)
+    return 0

worklogs/py.typed

@@ -0,0 +1 @@
+

worklogs-0.1.0.dist-info/METADATA

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: worklogs
+Version: 0.1.0
+Summary: Local markdown worklog helpers for developer workflows.
+Project-URL: Homepage, https://github.com/alik-git/worklogs
+Project-URL: Repository, https://github.com/alik-git/worklogs
+Project-URL: Issues, https://github.com/alik-git/worklogs/issues
+Author-email: Ali K <alikgithb@gmail.com>
+Maintainer-email: Ali K <alikgithb@gmail.com>
+Keywords: cli,developer-tools,markdown,notes,worklog
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: mypy>=1.15; extra == 'dev'
+Requires-Dist: pre-commit>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.11; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# worklogs
+
+Local markdown worklog helpers for developer workflows.
+
+This initial package release establishes the public package name, metadata,
+typed Python package layout, command entry point, CI, and PyPI trusted
+publishing path. The worklog creation and companion-note workflow will be added
+in follow-up releases.
+
+## Installation
+
+```bash
+python -m pip install worklogs
+```
+
+For local development:
+
+```bash
+uv sync --extra dev
+```
+
+Standard Python fallback:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+## Usage
+
+```bash
+worklogs --version
+```
+
+For shorter personal shell usage, add a local alias:
+
+```bash
+alias wl='worklogs'
+```
+
+The package installs the explicit `worklogs` command; `wl` is intentionally left
+as a shell-level shortcut so it cannot shadow another global command.
+
+## Development Workflow
+
+Run the standard checks before opening a PR:
+
+```bash
+uv run ruff format --check .
+uv run ruff check .
+uv run mypy
+uv run pytest
+uv build
+```
+
+If you are using standard Python tools instead of uv:
+
+```bash
+python -m ruff format --check .
+python -m ruff check .
+python -m mypy
+python -m pytest
+python -m build
+```
+
+## CI / GitHub Actions
+
+GitHub Actions runs:
+
+- fast Ruff-only checks
+- Ruff, mypy, and pytest
+- package build and wheel smoke test with pip
+- package build and wheel smoke test with uv
+
+The release workflow in [`.github/workflows/release.yml`](.github/workflows/release.yml)
+builds and publishes the package to PyPI when a GitHub Release is published.
+
+## Publishing
+
+This project uses PyPI Trusted Publishing. The PyPI pending publisher should be:
+
+```text
+PyPI project name: worklogs
+Owner: alik-git
+Repository name: worklogs
+Workflow name: release.yml
+Environment name: pypi
+```
+
+Create a GitHub Release for the version in [`pyproject.toml`](pyproject.toml):
+
+```bash
+gh release create v0.1.0 \
+  --title "v0.1.0" \
+  --notes "Initial package metadata release."
+```
+
+Publishing is release-driven on purpose: normal pushes and pull requests build
+and test the package, but only GitHub Releases publish to PyPI.

worklogs-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+worklogs/__init__.py,sha256=NKFyco1FQJaknzyhjowD0QQ67idyZ67K2PFfNHXTjp8,114
+worklogs/cli.py,sha256=omOG3_mFW0kjet6AOOkUOZv4K-mEd5hKSWHEVR_l5w0,741
+worklogs/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+worklogs-0.1.0.dist-info/METADATA,sha256=J11tYZTmy6wTLiEIoJ-o_83VlrewS77q2-ikZQqicEc,3144
+worklogs-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+worklogs-0.1.0.dist-info/entry_points.txt,sha256=TE_C0ehBksPfuTVfGvsCX_vb_r_tsBnUctOr-AeuAAg,47
+worklogs-0.1.0.dist-info/RECORD,,

worklogs-0.1.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

worklogs-0.1.0.dist-info/entry_points.txt

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