Metadata-Version: 2.4
Name: checkmarks
Version: 0.1.0
Summary: A simple CLI for tracking progress with markdown checklists
Author-email: menisadi <menisadi@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Meni
        
        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.
        
Keywords: cli,markdown,checklists
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Checkmarks

A simple command-line tool to check the progress of tasks in a Markdown checklist. It scans a `.md` file for checklist items (of the form `- [ ]` and `- [x]`) and displays a progress bar.

## Features

- Identifies completed (`- [x]`) and pending (`- [ ]`) tasks in a Markdown file.
- Calculates the number of tasks done vs. total tasks.
- Optionally displays the title from the first `# Heading` in the file.
- Shows a handy progress bar with completion percentage.

## Installation

1. Make sure you have Python 3.7+ installed.
2. Clone or download this repository.


## Usage

```bash
python checkmarks.py /path/to/your_checklist.md
```

## Example

Suppose you have a file named todo.md with the following content:
```markdown
# My Todo List

- [ ] Buy groceries
- [x] Write blog post
- [ ] Go running
```

Running python checkmarks.py todo.md will produce output like:
```
📊 Progress for:
My Todo List
[█-------] 1/3 tasks completed (33.3%)
```

## Contributing

Feel free to submit issues or pull requests. This is a small tool, so contributions are always welcome.

## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
