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.1.tar.gz (6.5 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.1-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vibemark-1.1.1.tar.gz
  • Upload date:
  • Size: 6.5 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.1.tar.gz
Algorithm Hash digest
SHA256 b168ff2cf0098d10719b18840f472b57eff9aacf53d148aa8a6ab13c49e1cd59
MD5 2055d853ff9ebc562f87abdc34057eec
BLAKE2b-256 82116645286e092fb87326c24c1385c2f9aecd5e957ba8623c778cc672c1a4db

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vibemark-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 358bf6e778c8e25190263c90efa4791b4d728ab18537ddfbfb72e107118d6a34
MD5 258ae7554ef001a9b007509dd8133633
BLAKE2b-256 1ec5094cf8b30caa1877ddec5dc1a1b96a12df97b97b762222422a4fbc717f88

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