Skip to main content

Local markdown worklog helpers for developer workflows.

Project description

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

python -m pip install worklogs

For local development:

uv sync --extra dev

Standard Python fallback:

python -m pip install -e ".[dev]"

Usage

worklogs --version

For shorter personal shell usage, add a local alias:

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:

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:

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 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:

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:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

worklogs-0.1.0.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

worklogs-0.1.0-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

Details for the file worklogs-0.1.0.tar.gz.

File metadata

  • Download URL: worklogs-0.1.0.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for worklogs-0.1.0.tar.gz
Algorithm Hash digest
SHA256 07229c5dbc8c6d62bc5723b03d6c0a7eaf19ecb67d565defd471928285a4bef3
MD5 df57a05124e9654631608cfb25649573
BLAKE2b-256 19bad5024d4097ec4332640a3370285c234c72a37592b87fbb113d952e28ac30

See more details on using hashes here.

Provenance

The following attestation bundles were made for worklogs-0.1.0.tar.gz:

Publisher: release.yml on alik-git/worklogs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file worklogs-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: worklogs-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for worklogs-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 84eb15ace637758336bf84998abcb0912fde2438925fcd926ad37c565caf24e6
MD5 936ff3c7efd8bc8754272f8e1c541a28
BLAKE2b-256 120e572380faba4bbc0234d9b8c6a972205c747fec0537b580cffdac76b60b8a

See more details on using hashes here.

Provenance

The following attestation bundles were made for worklogs-0.1.0-py3-none-any.whl:

Publisher: release.yml on alik-git/worklogs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page