cli-todo-jd 0.2.1__tar.gz → 0.3.0__tar.gz

cli_todo_jd-0.3.0/MANIFEST.in

@@ -0,0 +1 @@
+include cli_todo_jd/web/templates/index.html

{cli_todo_jd-0.2.1 → cli_todo_jd-0.3.0}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: cli-todo-jd
-Version: 0.2.1
+Version: 0.3.0
 Summary: Add your description here
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: questionary>=2.1.1
 Requires-Dist: rich>=14.2.0
 Requires-Dist: typer>=0.21.1
+Requires-Dist: flask>=3.0.0
 Provides-Extra: dev
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
@@ -19,23 +20,29 @@ A command line to do list with interactive menu
 ## What is`cli-todo-jd`?
 
 This is a command line interface todo list. Once installed, there are two ways to interact 
-with the list. 
+with the list stored as a sqlite database 
 
-### `todo_menu`
+### `todo menu`
 
-Once installed use `todo_menu` to launch into the interactive menu. From here you can add,
+Once installed use `todo menu` to launch into the interactive menu. From here you can add,
 remove, list, or clear your todo list. Items in your list are stored (by default) as
-`.todo_list.json`. The menu does also support optional filepaths using `-f` or `--filepath`.
+`.todo_list.db`. The menu does also support optional filepaths using `-f` or `--filepath`.
+
+### `todo web`
+
+Once installed use `todo web` to launch into the interactive web UI. From here you can add,
+remove, list, or clear your todo list. Items in your list are stored (by default) as
+`.todo_list.db`. The menu does also support optional filepaths using `-f` or `--filepath`.
 
 
 ### interacting with todo list without menu
 
 Alternately you can interact directly using the following commands (`--filepath can be substituted for -f`)
 
-- `todo_add text --filepath optional_path_to_json` used to add an item to your list
-- `todo_remove index --filepath optional_path_to_json` used to remove item number `index`
-- `todo_list --filepath optional_path_to_json` used to view list
-- `todo_clear --filepath optional_path_to_json` used to clear list (prompts y/n to confirm)
+- `todo add text --filepath optional_path_to_json` used to add an item to your list
+- `todo remove index --filepath optional_path_to_json` used to remove item number `index`
+- `todo list --filepath optional_path_to_json` used to view list
+- `todo clear --filepath optional_path_to_json` used to clear list (prompts y/n to confirm)
 
 ## Getting started
 

{cli_todo_jd-0.2.1 → cli_todo_jd-0.3.0}/README.md

@@ -5,23 +5,29 @@ A command line to do list with interactive menu
 ## What is`cli-todo-jd`?
 
 This is a command line interface todo list. Once installed, there are two ways to interact 
-with the list. 
+with the list stored as a sqlite database 
 
-### `todo_menu`
+### `todo menu`
 
-Once installed use `todo_menu` to launch into the interactive menu. From here you can add,
+Once installed use `todo menu` to launch into the interactive menu. From here you can add,
 remove, list, or clear your todo list. Items in your list are stored (by default) as
-`.todo_list.json`. The menu does also support optional filepaths using `-f` or `--filepath`.
+`.todo_list.db`. The menu does also support optional filepaths using `-f` or `--filepath`.
+
+### `todo web`
+
+Once installed use `todo web` to launch into the interactive web UI. From here you can add,
+remove, list, or clear your todo list. Items in your list are stored (by default) as
+`.todo_list.db`. The menu does also support optional filepaths using `-f` or `--filepath`.
 
 
 ### interacting with todo list without menu
 
 Alternately you can interact directly using the following commands (`--filepath can be substituted for -f`)
 
-- `todo_add text --filepath optional_path_to_json` used to add an item to your list
-- `todo_remove index --filepath optional_path_to_json` used to remove item number `index`
-- `todo_list --filepath optional_path_to_json` used to view list
-- `todo_clear --filepath optional_path_to_json` used to clear list (prompts y/n to confirm)
+- `todo add text --filepath optional_path_to_json` used to add an item to your list
+- `todo remove index --filepath optional_path_to_json` used to remove item number `index`
+- `todo list --filepath optional_path_to_json` used to view list
+- `todo clear --filepath optional_path_to_json` used to clear list (prompts y/n to confirm)
 
 ## Getting started
 

cli_todo_jd-0.3.0/cli_todo_jd/cli/cli_entry.py

@@ -0,0 +1,243 @@
+from __future__ import annotations
+
+from argparse import ArgumentParser
+from cli_todo_jd.helpers import (
+    add_item_to_list,
+    remove_item_from_list,
+    remove_item_from_list_by_id,
+    list_items_on_list,
+    clear_list_of_items,
+    mark_item_as_done,
+    mark_item_as_not_done,
+    mark_item_as_done_by_id,
+    mark_item_as_not_done_by_id,
+    edit_item_in_list_by_id,
+)
+from cli_todo_jd.cli.cli_menu import cli_menu
+from cli_todo_jd.web.app import run_web
+from pathlib import Path
+import typer
+
+app = typer.Typer(help="A tiny todo CLI built with Typer.")
+
+
+@app.command()
+def add(
+    text: list[str] = typer.Argument(..., help="Todo item text (no quotes needed)."),
+    filepath: Path = typer.Option(
+        Path(".todo_list.db"),
+        "--filepath",
+        "-f",
+        help="Path to the JSON file used for storage.",
+    ),
+) -> None:
+    full_text = " ".join(text).strip()
+    if not full_text:
+        raise typer.BadParameter("Todo item text cannot be empty.")
+
+    add_item_to_list(full_text, filepath)
+    typer.echo(f"Added: {full_text}")
+
+
+@app.command(name="list")
+def list_(
+    filepath: Path = typer.Option(Path(".todo_list.db"), "--filepath", "-f"),
+    show_all: bool = typer.Option(
+        False, "--all", "-a", help="Show all todos (open + done)."
+    ),
+    show_done: bool = typer.Option(
+        False, "--done", "-d", help="Show only completed todos."
+    ),
+    show_open: bool = typer.Option(
+        False, "--open", "-o", help="Show only open todos (default)."
+    ),
+) -> None:
+    """List todos.
+
+    Examples
+    --------
+    - todo list
+    - todo list --done
+    - todo list --all
+    - todo list -a
+    """
+
+    # Choose filter. If nothing specified, default to open.
+    # If the user specifies multiple flags, error out.
+    flags = [show_all, show_done, show_open]
+    if sum(1 for f in flags if f) > 1:
+        raise typer.BadParameter(
+            "Use only one of: --all / -a, --done / -d, --open / -o"
+        )
+
+    if show_all:
+        show = "all"
+    elif show_done:
+        show = "done"
+    else:
+        # default is open (or explicit --open)
+        show = "open"
+
+    list_items_on_list(filepath, show=show)
+
+
+@app.command()
+def remove(
+    todo_id: int | None = typer.Argument(None, help="Todo ID to remove (preferred)."),
+    index: int | None = typer.Option(
+        None,
+        "--index",
+        "-i",
+        help="1-based display index (legacy; use ID instead).",
+    ),
+    filepath: Path = typer.Option(Path(".todo_list.db"), "--filepath", "-f"),
+) -> None:
+    if todo_id is None and index is None:
+        raise typer.BadParameter("Provide either TODO_ID argument or --index/-i")
+    if todo_id is not None and index is not None:
+        raise typer.BadParameter("Provide either TODO_ID or --index/-i, not both")
+
+    if todo_id is not None:
+        remove_item_from_list_by_id(todo_id, filepath)
+    else:
+        remove_item_from_list(index, filepath)
+
+
+@app.command()
+def clear(
+    yes: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation prompt."),
+    filepath: Path = typer.Option(Path(".todo_list.db"), "--filepath", "-f"),
+) -> None:
+    if not yes and not typer.confirm(f"Clear all todos in {filepath}?"):
+        typer.echo("Cancelled.")
+        raise typer.Exit(code=1)
+
+    clear_list_of_items(filepath)
+
+
+@app.command()
+def edit(
+    todo_id: int = typer.Argument(..., help="Todo ID to edit."),
+    new_text: list[str] = typer.Argument(..., help="New text for the todo item."),
+    filepath: Path = typer.Option(Path(".todo_list.db"), "--filepath", "-f"),
+) -> None:
+    new_text_stripped = " ".join(new_text).strip()
+    if not new_text_stripped:
+        raise typer.BadParameter("New todo item text cannot be empty.")
+
+    edit_item_in_list_by_id(todo_id, new_text_stripped, filepath)
+    typer.echo(f'Edited todo ID {todo_id} to: "{new_text_stripped}"')
+
+
+@app.command(name="menu")
+def menu_(
+    filepath: Path = typer.Option(
+        Path(".todo_list.db"),
+        "--filepath",
+        "-f",
+        help="Path to the JSON file used for storage.",
+    ),
+) -> None:
+    cli_menu(filepath)
+    typer.echo("Exited menu.")
+
+
+@app.command()
+def done(
+    todo_id: int | None = typer.Argument(
+        None, help="Todo ID to mark as done (preferred)."
+    ),
+    index: int | None = typer.Option(
+        None,
+        "--index",
+        "-i",
+        help="1-based display index (legacy; use ID instead).",
+    ),
+    filepath: Path = typer.Option(Path(".todo_list.db"), "--filepath", "-f"),
+) -> None:
+    if todo_id is None and index is None:
+        raise typer.BadParameter("Provide either TODO_ID argument or --index/-i")
+    if todo_id is not None and index is not None:
+        raise typer.BadParameter("Provide either TODO_ID or --index/-i, not both")
+
+    if todo_id is not None:
+        mark_item_as_done_by_id(todo_id, filepath)
+    else:
+        mark_item_as_done(index, filepath)
+
+    list_items_on_list(filepath=filepath, show="all")
+
+
+@app.command(name="not-done")
+def not_done(
+    todo_id: int | None = typer.Argument(
+        None, help="Todo ID to mark as not done (preferred)."
+    ),
+    index: int | None = typer.Option(
+        None,
+        "--index",
+        "-i",
+        help="1-based display index (legacy; use ID instead).",
+    ),
+    filepath: Path = typer.Option(Path(".todo_list.db"), "--filepath", "-f"),
+) -> None:
+    if todo_id is None and index is None:
+        raise typer.BadParameter("Provide either TODO_ID argument or --index/-i")
+    if todo_id is not None and index is not None:
+        raise typer.BadParameter("Provide either TODO_ID or --index/-i, not both")
+
+    if todo_id is not None:
+        mark_item_as_not_done_by_id(todo_id, filepath)
+    else:
+        mark_item_as_not_done(index, filepath)
+
+    list_items_on_list(filepath=filepath, show="all")
+
+
+@app.command()
+def web(
+    filepath: Path = typer.Option(Path(".todo_list.db"), "--filepath", "-f"),
+    host: str = typer.Option(
+        "127.0.0.1", help="Host interface to bind the web server."
+    ),
+    port: int = typer.Option(8000, help="Port to run the web server on."),
+    debug: bool = typer.Option(False, help="Run Flask in debug mode."),
+) -> None:
+    """Run a local web UI for your todo list."""
+    run_web(filepath, host=host, port=port, debug=debug)
+
+
+def parser_optional_args(parser: ArgumentParser):
+    parser.add_argument(
+        "-f",
+        "--filepath",
+        help="Path to the file to process",
+        default="./.todo_list.db",
+    )
+
+
+def todo_menu():
+    parser = ArgumentParser(description="Todo List CLI Menu")
+    parser_optional_args(parser)
+    args = parser.parse_args()
+
+    cli_menu(filepath=args.filepath)
+
+
+def todo_web():
+    parser = ArgumentParser(description="Todo List Web Server")
+    parser_optional_args(parser)
+    parser.add_argument(
+        "--host", help="Host interface to bind the web server.", default="127.0.0.1"
+    )
+    parser.add_argument(
+        "--port", help="Port to run the web server on.", default=8000, type=int
+    )
+    parser.add_argument("--debug", help="Run Flask in debug mode.", action="store_true")
+    args = parser.parse_args()
+
+    run_web(db_path=args.filepath, host=args.host, port=args.port, debug=args.debug)
+
+
+if __name__ == "__main__":
+    app()

cli_todo_jd-0.3.0/cli_todo_jd/cli/cli_menu.py

@@ -0,0 +1,129 @@
+from questionary import Style
+import questionary
+from cli_todo_jd.helpers import create_list
+
+custom_style = Style(
+    [
+        ("qmark", "fg:#ff9d00 bold"),
+        ("question", "bold"),
+        ("answer", "fg:#ff9d00 bold"),
+        ("pointer", "fg:#ff9d00 bold"),
+        ("highlighted", "fg:#ff9d00 bold"),
+        ("selected", "fg:#ff9d00 bold"),
+        ("separator", "fg:#ff9d00 bold"),
+        ("instruction", ""),  # default
+        ("text", ""),
+        ("disabled", "fg:#ff9d00 italic"),
+    ]
+)
+
+
+def cli_menu(filepath="./.todo_list.db"):
+    """
+    Display the command-line interface menu for the todo list.
+
+    Parameters
+    ----------
+    filepath : str, optional
+        The file path to the JSON file for storing todos, by default "./.todo_list.db"
+    """
+    app = create_list(file_path_to_db=filepath)
+    while True:
+        action = questionary.select(
+            "What would you like to do?",
+            choices=[
+                "Add todo",
+                "List todos",
+                "Update todo status",
+                "Remove todo",
+                "Edit todo",
+                "Clear all todos",
+                "Exit",
+            ],
+            style=custom_style,
+        ).ask()
+
+        if action == "Add todo":
+            item = questionary.text("Enter the todo item:", style=custom_style).ask()
+            app.add_todo(item)
+        elif action == "List todos":
+            app.list_todos(show="all")
+        elif action == "Update todo status":
+            app.reload_todos()
+            if not app.todos:
+                print("No todos to update.")
+                continue
+            todo_choice = questionary.select(
+                "Select the todo to update:",
+                choices=["<Back>"] + app.todos,
+                style=custom_style,
+            ).ask()
+
+            if todo_choice == "<Back>" or todo_choice is None:
+                continue
+
+            todo_index = app.todos.index(todo_choice) + 1
+            status_choice = questionary.select(
+                "Mark as:",
+                choices=["Done", "Not Done", "<Back>"],
+                style=custom_style,
+            ).ask()
+
+            if status_choice == "<Back>" or status_choice is None:
+                continue
+            elif status_choice == "Done":
+                app.mark_as_done(todo_index)
+            elif status_choice == "Not Done":
+                app.mark_as_not_done(todo_index)
+            app.list_todos(show="all")
+        elif action == "Remove todo":
+            app.reload_todos()
+            if not app.todos:
+                print("No todos to remove.")
+                continue
+            todo_choice = questionary.select(
+                "Select the todo to remove:",
+                choices=["<Back>"] + app.todos,
+                style=custom_style,
+            ).ask()
+
+            if todo_choice == "<Back>" or todo_choice is None:
+                continue
+
+            todo_to_remove = app.todos.index(todo_choice) + 1
+            app.remove_todo(todo_to_remove)
+        elif action == "Edit todo":
+            app.reload_todos()
+            if not app.todos:
+                print("No todos to edit.")
+                continue
+            todo_choice = questionary.select(
+                "Select the todo to edit:",
+                choices=["<Back>"] + app.todos,
+                style=custom_style,
+            ).ask()
+
+            if todo_choice == "<Back>" or todo_choice is None:
+                continue
+
+            todo_index = app.todos.index(todo_choice) + 1
+            new_text = questionary.text(
+                "Enter the new text for the todo:",
+                default=todo_choice,
+                style=custom_style,
+            ).ask()
+
+            if new_text is None:
+                continue
+            app.edit_entry(todo_index, new_text)
+
+        elif action == "Clear all todos":
+            confirm = questionary.confirm(
+                "Are you sure you want to clear all todos?", style=custom_style
+            ).ask()
+            if confirm:
+                app.clear_all()
+        elif action == "Exit":
+            break
+        else:
+            break

cli_todo_jd-0.3.0/cli_todo_jd/helpers.py

@@ -0,0 +1,109 @@
+from cli_todo_jd.main import TodoApp
+
+
+def create_list(file_path_to_db: str = "./.todo_list.db"):
+    """
+    Create a new todo list.
+
+    Parameters
+    ----------
+    file_path_to_db : str, optional
+        The file path to the JSON file for storing todos, by default "./.todo_list.db"
+
+    Returns
+    -------
+    TodoApp
+        An instance of the TodoApp class.
+    """
+    app = TodoApp(file_path_to_db=file_path_to_db)
+    return app
+
+
+def add_item_to_list(item: str, filepath: str):
+    """
+    Add a new item to the todo list.
+
+    Parameters
+    ----------
+    item : str
+        The todo item to add.
+    filepath : str
+        The file path to the JSON file for storing todos.
+    """
+    app = create_list(file_path_to_db=filepath)
+    app.add_todo(item)
+    app.list_todos()
+
+
+def list_items_on_list(filepath: str, show: str = "open"):
+    """List items in the todo list.
+
+    Parameters
+    ----------
+    filepath:
+        The SQLite database path.
+    show:
+        "open" (default), "done", or "all".
+    """
+    app = create_list(file_path_to_db=filepath)
+    app.list_todos(show=show)
+
+
+def remove_item_from_list(index: int, filepath: str):
+    """
+    remove an item from the todo list using index
+
+    Parameters
+    ----------
+    index : int
+        The index of the todo item to remove.
+    filepath : str
+        The file path to the JSON file for storing todos.
+    """
+    app = create_list(file_path_to_db=filepath)
+    app.remove_todo(index)
+    app.list_todos()
+
+
+def clear_list_of_items(filepath: str):
+    """
+    Clear all items from the todo list.
+
+    Parameters
+    ----------
+    filepath : str
+        The file path to the JSON file for storing todos.
+    """
+    app = create_list(file_path_to_db=filepath)
+    app.clear_all()
+
+
+def mark_item_as_done(index: int, filepath: str):
+    app = create_list(file_path_to_db=filepath)
+    app.mark_as_done(index)
+
+
+def mark_item_as_not_done(index: int, filepath: str):
+    app = create_list(file_path_to_db=filepath)
+    app.mark_as_not_done(index)
+
+
+def remove_item_from_list_by_id(todo_id: int, filepath: str):
+    app = create_list(file_path_to_db=filepath)
+    app.remove_by_id(todo_id)
+    app.list_todos(show="all")
+
+
+def mark_item_as_done_by_id(todo_id: int, filepath: str):
+    app = create_list(file_path_to_db=filepath)
+    app.mark_done_by_id(todo_id)
+
+
+def mark_item_as_not_done_by_id(todo_id: int, filepath: str):
+    app = create_list(file_path_to_db=filepath)
+    app.mark_not_done_by_id(todo_id)
+
+
+def edit_item_in_list_by_id(todo_id: int, new_text: str, filepath: str):
+    app = create_list(file_path_to_db=filepath)
+    app.edit_by_id(todo_id, new_text)