Skip to main content

If you are not writing it, you should at least read it.

Project description

vibemark

Track how much code you have actually read, by file and by LOC. vibemark scans your repository for Python files, stores progress in a local state file, and provides simple commands to update or visualize your reading status.

Quickstart

  • Scan the repo and initialize progress:
    • uv run vibemark scan
  • Show overall progress and largest remaining files:
    • uv run vibemark stats
  • Mark a file as fully read:
    • uv run vibemark done src/vibemark/cli.py
  • Set partial progress for a file:
    • uv run vibemark set src/vibemark/cli.py 120

How it works

vibemark looks for *.py files under the repo root, applies default exclusions (e.g., .git/, .venv/, build/), and writes state to .vibemark.json in the root directory. Use vibemark update to rescan and optionally reset progress for changed files.

Development

  • Run the CLI:
    • uv run vibemark --help
  • Run tests:
    • uv run pytest

Requirements

  • Python 3.13+
  • uv for running and building

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

vibemark-1.0.0.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

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

vibemark-1.0.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file vibemark-1.0.0.tar.gz.

File metadata

  • Download URL: vibemark-1.0.0.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.9 {"installer":{"name":"uv","version":"0.9.9"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vibemark-1.0.0.tar.gz
Algorithm Hash digest
SHA256 4f680c69148ace0b9bd680b8c488216963cc8db1d964c0421ce3cbda07e0b364
MD5 4f1e687d1feb4ae8590c46e90c7c1e1c
BLAKE2b-256 515b705b85683043bb301a061e70b11f51fdb2b246fda77ea3edbdd6772c8b63

See more details on using hashes here.

File details

Details for the file vibemark-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: vibemark-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.9 {"installer":{"name":"uv","version":"0.9.9"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vibemark-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 18f2fa96a2ca4a9297cac4cdc358d8285278bedb21d6d71c5488123f63d51fbe
MD5 d8f21eaaff723e67b4d268faa55d6b98
BLAKE2b-256 16745195a07e287f50bb26cb0c2a011820feb08c9480160cd37774d9acc22d3e

See more details on using hashes here.

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