Metadata-Version: 2.3
Name: vibemark
Version: 1.3.4
Summary: If you are not writing it, you should at least read it.
Author: menisadi
Author-email: menisadi <menisadi@gmail.com>
License: MIT License
         
         Copyright (c) 2026 menisadi
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Requires-Dist: rich>=14.2.0
Requires-Dist: typer>=0.21.0
Requires-Python: >=3.13
Description-Content-Type: text/markdown

# vibemark

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

## Installation

The main way to use vibemark is via PyPI under the `vibemark` package:

- `pipx install vibemark`
- `pip install vibemark`
- `uv tool install vibemark` (recommended)

## Quickstart

- Scan the repo and initialize progress:
  - `vibemark scan`
- Show overall progress and largest remaining files:
  - `vibemark stats`
  - `vibemark stats --top 30` / `vibemark stats --all`
  - `vibemark stats --no-table` (totals only)
  - `vibemark stats --format csv|tsv` (machine-readable output)
- Mark a file as fully read:
  - `vibemark done src/vibemark/cli.py`
- Set partial progress for a file:
  - `vibemark set src/vibemark/cli.py 120`
- Exclude a folder for a run (glob):
  - `vibemark scan --exclude "src/vendor/*"`
- Persistently exclude a folder (saved in `.vibemark.json`):
  - `vibemark exclude add "src/vendor/*"`

## More commands

- `vibemark update` re-scan and optionally reset changed files
- `vibemark update --reset-changed yes|no` skip per-file prompts (default: ask)
- `vibemark reset path/to/file.py` mark a file unread
- `vibemark export-md` export a markdown checklist
- `vibemark exclude remove|list|clear`
- `vibemark ext add|remove|list|clear`
- `vibemark --version`

## How it works

`vibemark` looks for files matching the configured extensions (default: `py`) under
the repo root, applies default exclusions (e.g., `.git/`, `.venv/`, `build/`), and
writes state to `.vibemark.json` in the root directory. You can add saved exclude globs like `src/vendor/*` or pass `--exclude` to a single scan. You can also include other extensions via `--ext`
or the `vibemark ext` subcommands. Use `vibemark update` to rescan and optionally reset
progress for changed files. For finer control, `scan`/`update` accept `--loc-mode`
(`physical|nonempty`) and `--include-empty`.

## Development

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

## Requirements

- Python 3.13+
- `uv` for running and building from source
