qbit-cli 0.1.0__tar.gz

qbit_cli-0.1.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: qbit-cli
+Version: 0.1.0
+Summary: A lightweight CLI todo list manager
+Author: qbit contributors
+License-Expression: MIT
+Keywords: todo,cli,task-manager
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# qbit
+
+A lightweight CLI todo app for your terminal.
+
+## Features
+
+- Add tasks
+- List tasks
+- Mark tasks as done
+- Delete tasks
+- Clear completed tasks
+
+## Installation
+
+### Local editable install
+
+```bash
+pip install -e .
+```
+
+### Install from built wheel
+
+```bash
+python -m build
+pip install dist/qbit-0.1.0-py3-none-any.whl
+```
+
+## Release to TestPyPI and PyPI
+
+Install Twine:
+
+```bash
+pip install twine build
+```
+
+Build artifacts:
+
+```bash
+python -m build
+```
+
+Upload to TestPyPI:
+
+```bash
+python -m twine upload --repository testpypi dist/*
+```
+
+Test install from TestPyPI:
+
+```bash
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple qbit
+```
+
+Upload to PyPI:
+
+```bash
+python -m twine upload dist/*
+```
+
+## Usage
+
+```bash
+qbit add "Buy milk"
+qbit list
+qbit done 1
+qbit delete 1
+qbit clear
+```
+
+## Data location
+
+qbit stores data in an OS-specific user data directory:
+
+- Windows: `%APPDATA%/qbit/todos.json`
+- macOS: `~/Library/Application Support/qbit/todos.json`
+- Linux: `$XDG_DATA_HOME/qbit/todos.json` or `~/.local/share/qbit/todos.json`
+
+You can override the file path with:
+
+```bash
+qbit --data-file /path/to/todos.json list
+```

qbit_cli-0.1.0/README.md

@@ -0,0 +1,82 @@
+# qbit
+
+A lightweight CLI todo app for your terminal.
+
+## Features
+
+- Add tasks
+- List tasks
+- Mark tasks as done
+- Delete tasks
+- Clear completed tasks
+
+## Installation
+
+### Local editable install
+
+```bash
+pip install -e .
+```
+
+### Install from built wheel
+
+```bash
+python -m build
+pip install dist/qbit-0.1.0-py3-none-any.whl
+```
+
+## Release to TestPyPI and PyPI
+
+Install Twine:
+
+```bash
+pip install twine build
+```
+
+Build artifacts:
+
+```bash
+python -m build
+```
+
+Upload to TestPyPI:
+
+```bash
+python -m twine upload --repository testpypi dist/*
+```
+
+Test install from TestPyPI:
+
+```bash
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple qbit
+```
+
+Upload to PyPI:
+
+```bash
+python -m twine upload dist/*
+```
+
+## Usage
+
+```bash
+qbit add "Buy milk"
+qbit list
+qbit done 1
+qbit delete 1
+qbit clear
+```
+
+## Data location
+
+qbit stores data in an OS-specific user data directory:
+
+- Windows: `%APPDATA%/qbit/todos.json`
+- macOS: `~/Library/Application Support/qbit/todos.json`
+- Linux: `$XDG_DATA_HOME/qbit/todos.json` or `~/.local/share/qbit/todos.json`
+
+You can override the file path with:
+
+```bash
+qbit --data-file /path/to/todos.json list
+```

qbit_cli-0.1.0/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "qbit-cli"
+version = "0.1.0"
+description = "A lightweight CLI todo list manager"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [{ name = "qbit contributors" }]
+keywords = ["todo", "cli", "task-manager"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: End Users/Desktop",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Utilities",
+]
+
+
+[project.scripts]
+qbit = "qbit.cli:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

qbit_cli-0.1.0/setup.cfg

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

qbit_cli-0.1.0/src/qbit/__init__.py

@@ -0,0 +1,4 @@
+"""qbit package."""
+
+__all__ = ["__version__"]
+__version__ = "0.1.0"

qbit_cli-0.1.0/src/qbit/cli.py

@@ -0,0 +1,105 @@
+"""Command-line interface for qbit."""
+
+from __future__ import annotations
+
+import argparse
+from pathlib import Path
+from typing import Sequence
+
+from .config import default_data_file
+from .storage import TodoStorage
+from .todo import TodoList
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(prog="qbit", description="Manage your todos from the CLI")
+    parser.add_argument(
+        "--data-file",
+        type=Path,
+        default=None,
+        help="Override the default todo data file path.",
+    )
+
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    add_parser = subparsers.add_parser("add", help="Add a new todo")
+    add_parser.add_argument("text", help="Todo text")
+
+    subparsers.add_parser("list", help="List todos")
+
+    done_parser = subparsers.add_parser("done", help="Mark a todo as completed")
+    done_parser.add_argument("id", type=int, help="Todo id")
+
+    delete_parser = subparsers.add_parser("delete", help="Delete a todo")
+    delete_parser.add_argument("id", type=int, help="Todo id")
+
+    subparsers.add_parser("clear", help="Clear completed todos")
+
+    return parser
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    parser = build_parser()
+    args = parser.parse_args(argv)
+
+    data_file = args.data_file if args.data_file else default_data_file()
+    storage = TodoStorage(data_file)
+
+    try:
+        todo_list = TodoList(storage.load())
+    except ValueError as exc:
+        print(f"Error: {exc}")
+        return 2
+
+    if args.command == "add":
+        try:
+            item = todo_list.add(args.text)
+        except ValueError as exc:
+            print(f"Error: {exc}")
+            return 2
+        storage.save(todo_list.items())
+        print(f"Added [{item.id}] {item.text}")
+        return 0
+
+    if args.command == "list":
+        items = todo_list.items()
+        if not items:
+            print("No todos yet.")
+            return 0
+        for item in items:
+            status = "x" if item.done else " "
+            print(f"[{item.id}] [{status}] {item.text}")
+        return 0
+
+    if args.command == "done":
+        try:
+            item = todo_list.mark_done(args.id)
+        except KeyError as exc:
+            print(f"Error: {exc}")
+            return 2
+        storage.save(todo_list.items())
+        print(f"Completed [{item.id}] {item.text}")
+        return 0
+
+    if args.command == "delete":
+        try:
+            item = todo_list.delete(args.id)
+        except KeyError as exc:
+            print(f"Error: {exc}")
+            return 2
+        storage.save(todo_list.items())
+        print(f"Deleted [{item.id}] {item.text}")
+        return 0
+
+    if args.command == "clear":
+        removed = todo_list.clear_completed()
+        storage.save(todo_list.items())
+        print(f"Removed {removed} completed todo(s)")
+        return 0
+
+    parser.print_help()
+    return 2
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

qbit_cli-0.1.0/src/qbit/config.py

@@ -0,0 +1,25 @@
+"""Configuration and OS-aware path helpers."""
+
+from __future__ import annotations
+
+import os
+import sys
+from pathlib import Path
+
+APP_NAME = "qbit"
+DEFAULT_FILE_NAME = "todos.json"
+
+
+def default_data_file() -> Path:
+    """Return the default todo data file path for the current OS."""
+    if sys.platform.startswith("win"):
+        appdata = os.environ.get("APPDATA")
+        base_dir = Path(appdata) if appdata else Path.home() / "AppData" / "Roaming"
+        return base_dir / APP_NAME / DEFAULT_FILE_NAME
+
+    if sys.platform == "darwin":
+        return Path.home() / "Library" / "Application Support" / APP_NAME / DEFAULT_FILE_NAME
+
+    xdg_data_home = os.environ.get("XDG_DATA_HOME")
+    base_dir = Path(xdg_data_home) if xdg_data_home else Path.home() / ".local" / "share"
+    return base_dir / APP_NAME / DEFAULT_FILE_NAME

qbit_cli-0.1.0/src/qbit/storage.py

@@ -0,0 +1,38 @@
+"""Persistence layer for todo data."""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+
+from .todo import TodoItem
+
+
+class TodoStorage:
+    """Reads and writes todos from a JSON file."""
+
+    def __init__(self, data_file: Path) -> None:
+        self._data_file = data_file
+
+    def load(self) -> list[TodoItem]:
+        if not self._data_file.exists():
+            return []
+
+        with self._data_file.open("r", encoding="utf-8") as handle:
+            payload = json.load(handle)
+
+        if not isinstance(payload, list):
+            raise ValueError("Corrupted data: expected a JSON list.")
+
+        return [TodoItem.from_dict(item) for item in payload]
+
+    def save(self, items: list[TodoItem]) -> None:
+        self._data_file.parent.mkdir(parents=True, exist_ok=True)
+        temp_file = self._data_file.with_suffix(self._data_file.suffix + ".tmp")
+
+        serialized = [item.to_dict() for item in items]
+        with temp_file.open("w", encoding="utf-8") as handle:
+            json.dump(serialized, handle, indent=2)
+            handle.write("\n")
+
+        temp_file.replace(self._data_file)

qbit_cli-0.1.0/src/qbit/todo.py

@@ -0,0 +1,78 @@
+"""Core todo domain logic."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, asdict
+from datetime import datetime, timezone
+
+
+@dataclass
+class TodoItem:
+    """A single todo item."""
+
+    id: int
+    text: str
+    done: bool = False
+    created_at: str = ""
+
+    def to_dict(self) -> dict:
+        return asdict(self)
+
+    @classmethod
+    def from_dict(cls, payload: dict) -> "TodoItem":
+        return cls(
+            id=int(payload["id"]),
+            text=str(payload["text"]),
+            done=bool(payload.get("done", False)),
+            created_at=str(payload.get("created_at", "")),
+        )
+
+
+class TodoList:
+    """Mutable list of todo items with stable integer IDs."""
+
+    def __init__(self, items: list[TodoItem] | None = None) -> None:
+        self._items = items[:] if items else []
+
+    def items(self) -> list[TodoItem]:
+        return self._items[:]
+
+    def add(self, text: str) -> TodoItem:
+        text = text.strip()
+        if not text:
+            raise ValueError("Todo text cannot be empty.")
+
+        item = TodoItem(
+            id=self._next_id(),
+            text=text,
+            done=False,
+            created_at=datetime.now(timezone.utc).isoformat(),
+        )
+        self._items.append(item)
+        return item
+
+    def mark_done(self, item_id: int) -> TodoItem:
+        item = self._find(item_id)
+        item.done = True
+        return item
+
+    def delete(self, item_id: int) -> TodoItem:
+        item = self._find(item_id)
+        self._items = [existing for existing in self._items if existing.id != item_id]
+        return item
+
+    def clear_completed(self) -> int:
+        before = len(self._items)
+        self._items = [item for item in self._items if not item.done]
+        return before - len(self._items)
+
+    def _next_id(self) -> int:
+        if not self._items:
+            return 1
+        return max(item.id for item in self._items) + 1
+
+    def _find(self, item_id: int) -> TodoItem:
+        for item in self._items:
+            if item.id == item_id:
+                return item
+        raise KeyError(f"Todo with id {item_id} was not found.")

qbit_cli-0.1.0/src/qbit_cli.egg-info/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: qbit-cli
+Version: 0.1.0
+Summary: A lightweight CLI todo list manager
+Author: qbit contributors
+License-Expression: MIT
+Keywords: todo,cli,task-manager
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# qbit
+
+A lightweight CLI todo app for your terminal.
+
+## Features
+
+- Add tasks
+- List tasks
+- Mark tasks as done
+- Delete tasks
+- Clear completed tasks
+
+## Installation
+
+### Local editable install
+
+```bash
+pip install -e .
+```
+
+### Install from built wheel
+
+```bash
+python -m build
+pip install dist/qbit-0.1.0-py3-none-any.whl
+```
+
+## Release to TestPyPI and PyPI
+
+Install Twine:
+
+```bash
+pip install twine build
+```
+
+Build artifacts:
+
+```bash
+python -m build
+```
+
+Upload to TestPyPI:
+
+```bash
+python -m twine upload --repository testpypi dist/*
+```
+
+Test install from TestPyPI:
+
+```bash
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple qbit
+```
+
+Upload to PyPI:
+
+```bash
+python -m twine upload dist/*
+```
+
+## Usage
+
+```bash
+qbit add "Buy milk"
+qbit list
+qbit done 1
+qbit delete 1
+qbit clear
+```
+
+## Data location
+
+qbit stores data in an OS-specific user data directory:
+
+- Windows: `%APPDATA%/qbit/todos.json`
+- macOS: `~/Library/Application Support/qbit/todos.json`
+- Linux: `$XDG_DATA_HOME/qbit/todos.json` or `~/.local/share/qbit/todos.json`
+
+You can override the file path with:
+
+```bash
+qbit --data-file /path/to/todos.json list
+```

qbit_cli-0.1.0/src/qbit_cli.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.md
+pyproject.toml
+src/qbit/__init__.py
+src/qbit/cli.py
+src/qbit/config.py
+src/qbit/storage.py
+src/qbit/todo.py
+src/qbit_cli.egg-info/PKG-INFO
+src/qbit_cli.egg-info/SOURCES.txt
+src/qbit_cli.egg-info/dependency_links.txt
+src/qbit_cli.egg-info/entry_points.txt
+src/qbit_cli.egg-info/top_level.txt
+tests/test_cli.py
+tests/test_storage.py
+tests/test_todo.py

qbit_cli-0.1.0/src/qbit_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

qbit_cli-0.1.0/src/qbit_cli.egg-info/entry_points.txt

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

qbit_cli-0.1.0/src/qbit_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+qbit

qbit_cli-0.1.0/tests/test_cli.py

@@ -0,0 +1,42 @@
+from pathlib import Path
+
+from qbit.cli import main
+
+
+def test_cli_add_then_list(tmp_path, capsys):
+    data_file = tmp_path / "todos.json"
+
+    rc_add = main(["--data-file", str(data_file), "add", "buy milk"])
+    out_add = capsys.readouterr().out
+
+    assert rc_add == 0
+    assert "Added [1] buy milk" in out_add
+
+    rc_list = main(["--data-file", str(data_file), "list"])
+    out_list = capsys.readouterr().out
+
+    assert rc_list == 0
+    assert "[1] [ ] buy milk" in out_list
+
+
+def test_cli_done_missing_id_returns_error(tmp_path, capsys):
+    data_file = tmp_path / "todos.json"
+
+    rc = main(["--data-file", str(data_file), "done", "99"])
+    out = capsys.readouterr().out
+
+    assert rc == 2
+    assert "Error:" in out
+
+
+def test_cli_clear_completed(tmp_path, capsys):
+    data_file = Path(tmp_path) / "todos.json"
+
+    main(["--data-file", str(data_file), "add", "task1"])
+    main(["--data-file", str(data_file), "done", "1"])
+
+    rc = main(["--data-file", str(data_file), "clear"])
+    out = capsys.readouterr().out
+
+    assert rc == 0
+    assert "Removed 1 completed todo(s)" in out

qbit_cli-0.1.0/tests/test_storage.py

@@ -0,0 +1,32 @@
+import json
+
+from qbit.storage import TodoStorage
+from qbit.todo import TodoItem
+
+
+def test_load_returns_empty_when_file_missing(tmp_path):
+    storage = TodoStorage(tmp_path / "missing.json")
+
+    assert storage.load() == []
+
+
+def test_save_and_load_round_trip(tmp_path):
+    file_path = tmp_path / "todos.json"
+    storage = TodoStorage(file_path)
+
+    storage.save([TodoItem(id=1, text="buy milk", done=False, created_at="ts")])
+
+    loaded = storage.load()
+    assert len(loaded) == 1
+    assert loaded[0].id == 1
+    assert loaded[0].text == "buy milk"
+
+
+def test_save_writes_valid_json(tmp_path):
+    file_path = tmp_path / "todos.json"
+    storage = TodoStorage(file_path)
+
+    storage.save([TodoItem(id=3, text="x", done=True, created_at="now")])
+
+    parsed = json.loads(file_path.read_text(encoding="utf-8"))
+    assert parsed[0]["id"] == 3

qbit_cli-0.1.0/tests/test_todo.py

@@ -0,0 +1,43 @@
+from qbit.todo import TodoItem, TodoList
+
+
+def test_add_assigns_incrementing_ids():
+    todo_list = TodoList()
+
+    one = todo_list.add("one")
+    two = todo_list.add("two")
+
+    assert one.id == 1
+    assert two.id == 2
+
+
+def test_mark_done_updates_state():
+    todo_list = TodoList([TodoItem(id=7, text="task")])
+
+    item = todo_list.mark_done(7)
+
+    assert item.done is True
+
+
+def test_delete_removes_item():
+    todo_list = TodoList([TodoItem(id=1, text="a"), TodoItem(id=2, text="b")])
+
+    removed = todo_list.delete(1)
+
+    assert removed.id == 1
+    assert [item.id for item in todo_list.items()] == [2]
+
+
+def test_clear_completed_removes_only_done_items():
+    todo_list = TodoList(
+        [
+            TodoItem(id=1, text="a", done=True),
+            TodoItem(id=2, text="b", done=False),
+            TodoItem(id=3, text="c", done=True),
+        ]
+    )
+
+    removed = todo_list.clear_completed()
+
+    assert removed == 2
+    assert [item.id for item in todo_list.items()] == [2]