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 from source

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.1.0.tar.gz (6.1 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.1.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vibemark-1.1.0.tar.gz
  • Upload date:
  • Size: 6.1 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.1.0.tar.gz
Algorithm Hash digest
SHA256 42ffa49d616d72e2304a762220038c3c161f20270a7106dd180703a2bab7ed5a
MD5 abfeb2c5552d651a5029696ba60618bc
BLAKE2b-256 796255b7c20915787b574aaa1748267592f47417e1a41cbf6b9d47494ed23ea0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vibemark-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.2 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0952749ae24ede636ff6136bcc056bede199b96559f93aeb0a957ad9863104b4
MD5 ceb86e764fd1534ddecd34a425ac35b7
BLAKE2b-256 90a6127cc2bd623d69b6ebb279ddd764f0200a76a136d9d2fa7ac330e11e7676

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