checkmarks 0.1.0__tar.gz

checkmarks-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+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.

checkmarks-0.1.0/PKG-INFO

@@ -0,0 +1,79 @@
+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.

checkmarks-0.1.0/README.md

@@ -0,0 +1,47 @@
+# 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.

checkmarks-0.1.0/checkmarks/cli.py

@@ -0,0 +1,58 @@
+import argparse
+import re
+from pathlib import Path
+
+
+def parse_checklist(file_path: Path) -> tuple[int, int, str | None]:
+    """Parses a markdown checklist file and returns task counts and optional title."""
+    with file_path.open("r", encoding="utf-8") as f:
+        content = f.read()
+
+    # Find all checklist items
+    all_tasks: list[str] = re.findall(r"- \[( |x)\] ", content)
+    total: int = len(all_tasks)
+    done: int = sum(1 for t in all_tasks if t == "x")
+
+    # Try to extract the first level-1 heading as the title
+    title_match = re.search(r"^# (.+)", content, re.MULTILINE)
+    title: str | None = title_match.group(1).strip() if title_match else None
+
+    return done, total, title
+
+
+def show_progress(
+    done: int, total: int, title: str | None = None, bar_length: int = 40
+) -> None:
+    """Displays a progress bar in the terminal, optionally with a custom title."""
+    percent: float = (done / total) * 100 if total else 0
+    filled_length: int = int(bar_length * done // total) if total else 0
+    bar: str = "█" * filled_length + "-" * (bar_length - filled_length)
+
+    heading: str = (
+        f"📊 Progress for:\n{title}" if title else "📊 Checklist Progress"
+    )
+    print(f"\n{heading}")
+    print(f"[{bar}] {done}/{total} tasks completed ({percent:.1f}%)\n")
+
+
+def main() -> None:
+    """Main entry point for the CLI."""
+    parser = argparse.ArgumentParser(
+        description="Track Markdown checklist progress"
+    )
+    parser.add_argument(
+        "markdown_file", type=str, help="Path to your checklist .md file"
+    )
+    args = parser.parse_args()
+
+    md_path: Path = Path(args.markdown_file)
+    if not md_path.exists():
+        print(f"❌ File not found: {md_path}")
+        return
+
+    done, total, title = parse_checklist(md_path)
+    show_progress(done, total, title)
+
+
+if __name__ == "__main__":
+    main()

checkmarks-0.1.0/checkmarks.egg-info/PKG-INFO

@@ -0,0 +1,79 @@
+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.

checkmarks-0.1.0/checkmarks.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+checkmarks/__init__.py
+checkmarks/cli.py
+checkmarks.egg-info/PKG-INFO
+checkmarks.egg-info/SOURCES.txt
+checkmarks.egg-info/dependency_links.txt
+checkmarks.egg-info/entry_points.txt
+checkmarks.egg-info/top_level.txt
+tests/test_cli.py

checkmarks-0.1.0/checkmarks.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

checkmarks-0.1.0/checkmarks.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+checkmarks = checkmarks.cli:main

checkmarks-0.1.0/checkmarks.egg-info/top_level.txt

@@ -0,0 +1 @@
+checkmarks

checkmarks-0.1.0/pyproject.toml

@@ -0,0 +1,18 @@
+[project]
+name = "checkmarks"
+version = "0.1.0"
+description = "A simple CLI for tracking progress with markdown checklists"
+authors = [
+  { name = "menisadi", email = "menisadi@gmail.com" }
+]
+
+readme = "README.md"
+
+license = { file = "LICENSE" }
+
+keywords = ["cli", "markdown", "checklists"]
+
+dependencies = []
+
+[project.scripts]
+checkmarks = "checkmarks.cli:main"

checkmarks-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

checkmarks-0.1.0/tests/test_cli.py

@@ -0,0 +1,107 @@
+import pytest
+import re
+from pathlib import Path
+from checkmarks.cli import parse_checklist, show_progress, main
+
+
+# Pytest can create and manage temporary files/directories via the 'tmp_path' fixture
+def test_parse_checklist_no_tasks(tmp_path: Path):
+    # Create an empty markdown file
+    md_file = tmp_path / "empty_checklist.md"
+    md_file.write_text("", encoding="utf-8")
+
+    done, total, title = parse_checklist(md_file)
+    assert done == 0
+    assert total == 0
+    assert title is None
+
+
+def test_parse_checklist_with_tasks(tmp_path: Path):
+    # A sample markdown with tasks and a level-1 heading
+    content = """# My Checklist
+
+- [ ] Task 1
+- [x] Task 2
+- [x] Task 3
+- [ ] Task 4
+"""
+    md_file = tmp_path / "tasks.md"
+    md_file.write_text(content, encoding="utf-8")
+
+    done, total, title = parse_checklist(md_file)
+    # We expect 2 done tasks, 4 total tasks, and the title "My Checklist"
+    assert done == 2
+    assert total == 4
+    assert title == "My Checklist"
+
+
+def test_parse_checklist_no_title(tmp_path: Path):
+    # A file with tasks but no H1 heading
+    content = """- [ ] Task A
+- [x] Task B
+"""
+    md_file = tmp_path / "notitle.md"
+    md_file.write_text(content, encoding="utf-8")
+
+    done, total, title = parse_checklist(md_file)
+    assert done == 1
+    assert total == 2
+    assert title is None
+
+
+def test_show_progress_output(capsys):
+    # Test that show_progress prints the correct bar and summary
+    show_progress(done=3, total=5, title="Test Title", bar_length=10)
+
+    # capsys captures stdout/stderr output in pytest
+    captured = capsys.readouterr()
+    output = captured.out
+
+    # Check that certain strings/patterns appear in the output
+    assert "Test Title" in output
+    assert "3/5 tasks completed" in output
+    # Check for the ASCII bar
+    # We expect 3 out of 5 => 60%, so bar_length=10 => 6 "█" if rounding down
+    # Actually the code does integer math with //, so 3 * 10 // 5 = 6.
+    assert re.search(r"\[█{6}-{4}\]", output) is not None
+    assert "(60.0%)" in output
+
+
+@pytest.mark.parametrize(
+    "done,total,percent_str",
+    [
+        (0, 0, "(0.0%)"),  # edge case: no tasks
+        (0, 5, "(0.0%)"),  # none done
+        (5, 5, "(100.0%)"),  # all done
+    ],
+)
+def test_show_progress_edge_cases(done, total, percent_str, capsys):
+    show_progress(done, total, title=None, bar_length=10)
+    output = capsys.readouterr().out
+    # Just check the percentage part is correct
+    assert percent_str in output
+
+
+def test_main_file_not_found(monkeypatch, capsys):
+    # We'll pretend the user ran: `checklist not_a_file.md`
+    test_args = ["checklist", "not_a_file.md"]
+    monkeypatch.setattr("sys.argv", test_args)
+
+    main()
+    output = capsys.readouterr().out
+    assert "❌ File not found: not_a_file.md" in output
+
+
+def test_main_valid_file(monkeypatch, capsys, tmp_path):
+    # Create a temporary markdown file
+    md_file = tmp_path / "test.md"
+    md_file.write_text("# Title\n- [ ] One\n- [x] Two", encoding="utf-8")
+
+    # We'll pretend the user ran: `checklist test.md`
+    test_args = ["checklist", str(md_file)]
+    monkeypatch.setattr("sys.argv", test_args)
+
+    main()
+    output = capsys.readouterr().out
+    assert "Title" in output
+    assert "1/2 tasks completed" in output