cli-todo-jd 0.1.0__tar.gz

cli_todo_jd-0.1.0/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: cli-todo-jd
+Version: 0.1.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
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: bump-my-version; extra == "dev"
+
+# cli-todo-jd
+
+A command line to do list with interactive menu
+
+## Getting started
+
+To start using this project, first make sure your system meets its
+requirements.
+
+It's suggested that you install this package and its requirements within
+a virtual environment.
+
+## Requirements
+
+- Python 3.9+ installed
+
+## Installing the package
+
+Whilst in the root folder, in a terminal, you can install the package and its
+Python dependencies using:
+
+```shell
+python -m pip install -U pip setuptools
+pip install -e .
+```
+
+### Install for contributors/developers
+
+To install the contributing requirements, use:
+```shell
+python -m pip install -U pip setuptools
+pip install -e .[dev]
+pre-commit install
+```
+
+This installs an editable version of the package. This means that when you update the
+package code you do not have to reinstall it for the changes to take effect.
+This saves a lot of time when you test your code.
+
+Remember to update the setup and requirement files inline with any changes to your
+package.
+
+
+## Licence
+
+Unless stated otherwise, the codebase is released under the MIT License. This covers
+both the codebase and any sample code in the documentation.
+
+## Contributing
+
+If you want to help us build and improve `{{ cookiecutter.project_slug }}`, please take a look at our
+[contributing guidelines][contributing].
+
+## Acknowledgements
+
+This project structure is based on the [`govcookiecutter` template project][govcookiecutter].
+
+[contributing]: https://github.com/best-practice-and-impact/govcookiecutter/blob/main/%7B%7B%20cookiecutter.repo_name%20%7D%7D/docs/contributor_guide/CONTRIBUTING.md
+[govcookiecutter]: https://github.com/best-practice-and-impact/govcookiecutter

cli_todo_jd-0.1.0/README.md

@@ -0,0 +1,59 @@
+# cli-todo-jd
+
+A command line to do list with interactive menu
+
+## Getting started
+
+To start using this project, first make sure your system meets its
+requirements.
+
+It's suggested that you install this package and its requirements within
+a virtual environment.
+
+## Requirements
+
+- Python 3.9+ installed
+
+## Installing the package
+
+Whilst in the root folder, in a terminal, you can install the package and its
+Python dependencies using:
+
+```shell
+python -m pip install -U pip setuptools
+pip install -e .
+```
+
+### Install for contributors/developers
+
+To install the contributing requirements, use:
+```shell
+python -m pip install -U pip setuptools
+pip install -e .[dev]
+pre-commit install
+```
+
+This installs an editable version of the package. This means that when you update the
+package code you do not have to reinstall it for the changes to take effect.
+This saves a lot of time when you test your code.
+
+Remember to update the setup and requirement files inline with any changes to your
+package.
+
+
+## Licence
+
+Unless stated otherwise, the codebase is released under the MIT License. This covers
+both the codebase and any sample code in the documentation.
+
+## Contributing
+
+If you want to help us build and improve `{{ cookiecutter.project_slug }}`, please take a look at our
+[contributing guidelines][contributing].
+
+## Acknowledgements
+
+This project structure is based on the [`govcookiecutter` template project][govcookiecutter].
+
+[contributing]: https://github.com/best-practice-and-impact/govcookiecutter/blob/main/%7B%7B%20cookiecutter.repo_name%20%7D%7D/docs/contributor_guide/CONTRIBUTING.md
+[govcookiecutter]: https://github.com/best-practice-and-impact/govcookiecutter

cli_todo_jd-0.1.0/cli_todo_jd/cli_entry.py

@@ -0,0 +1,75 @@
+from argparse import ArgumentParser
+from cli_todo_jd.main import (
+    add_item_to_list,
+    remove_item_from_list,
+    list_items_on_list,
+    clear_list_of_items,
+)
+
+
+def parser_optional_args(parser: ArgumentParser):
+    parser.add_argument(
+        "-f",
+        "--filepath",
+        help="Path to the file to process",
+        default="./.todo_list.json",
+    )
+
+
+def add_item():
+    parser = ArgumentParser(description="Add a todo item")
+    parser.add_argument(
+        "item",
+        nargs="+",
+        help="The todo item to add (use quotes or multiple words)",
+    )
+    parser_optional_args(parser)
+
+    args = parser.parse_args()
+    args.item = " ".join(args.item)
+    add_item_to_list(args.item, args.filepath)
+
+
+def remove_item():
+    parser = ArgumentParser(description="Remove a todo item by index")
+    parser.add_argument(
+        "index",
+        type=int,
+        help="The index of the todo item to remove (1-based)",
+    )
+    parser_optional_args(parser)
+
+    args = parser.parse_args()
+    remove_item_from_list(args.index, args.filepath)
+
+
+def list_items():
+    parser = ArgumentParser(description="List all todo items")
+    parser_optional_args(parser)
+
+    args = parser.parse_args()
+    list_items_on_list(args.filepath)
+
+
+def clear_list():
+    parser = ArgumentParser(description="Clear all todo items")
+    parser.add_argument(
+        "-y",
+        "--yes",
+        action="store_true",
+        help="Do not prompt for confirmation",
+    )
+    parser_optional_args(parser)
+
+    args = parser.parse_args()
+    list_items_on_list(args.filepath)
+
+    if not args.yes:
+        resp = (
+            input(f"Clear all todo items in '{args.filepath}'? [y/n]: ").strip().lower()
+        )
+        if resp not in ("y", "yes"):
+            return
+
+    # assuming remove_item_from_list(0/None) clears; otherwise replace with your clear implementation
+    clear_list_of_items(args.filepath)

cli_todo_jd-0.1.0/cli_todo_jd/main.py

@@ -0,0 +1,215 @@
+import json
+from pathlib import Path
+import questionary
+from rich.console import Console
+from rich.table import Table
+from rich.padding import Padding
+
+
+def main():
+    TodoApp()
+
+
+class TodoApp:
+    """
+    A simple command-line todo application.
+    """
+
+    def __init__(self, file_path_to_json="./.todo_list.json"):
+        self.todos = []
+        self.file_path_to_json = Path(file_path_to_json)
+        self._check_and_load_todos(self.file_path_to_json)
+        self._console = Console()
+
+    def add_todo(self, item):
+        self.todos.append(item)
+        print(f'Added todo: "{item}"')
+
+    def list_todos(self):
+        if not self.todos:
+            print("No todos found.")
+            return
+        self._table_print()
+
+    def remove_todo(self, index):
+        try:
+            removed = self.todos.pop(index - 1)
+            print(f'Removed todo: "{removed}"')
+        except IndexError:
+            print("Error: Invalid todo index.")
+
+    def _check_and_load_todos(self, file_path):
+        if file_path.exists():
+            try:
+                with file_path.open("r", encoding="utf-8") as f:
+                    self.todos = json.load(f)
+            except (json.JSONDecodeError, OSError):
+                print("Warning: Failed to load existing todos. Starting fresh.")
+
+    def write_todos(self):
+        try:
+            with self.file_path_to_json.open("w", encoding="utf-8") as f:
+                json.dump(self.todos, f, ensure_ascii=False, indent=2)
+        except OSError as e:
+            print(f"Warning: failed to save todos: {e}")
+
+    def _table_print(
+        self,
+        title: str | None = None,
+        style: str = "bold cyan",
+    ):
+        table = Table(
+            title=title, header_style=style, border_style=style, show_lines=True
+        )
+        columns = ["ID", "Todo Item"]
+        for col in columns:
+            table.add_column(str(col))
+        for idx, todo in enumerate(self.todos, start=1):
+            table.add_row(f"{idx}.", todo)
+        self._console.print(Padding(table, (2, 2)))
+
+
+def create_list(file_path_to_json: str = "./.todo_list.json"):
+    """
+    Create a new todo list.
+
+    Parameters
+    ----------
+    file_path_to_json : str, optional
+        The file path to the JSON file for storing todos, by default "./.todo_list.json"
+
+    Returns
+    -------
+    TodoApp
+        An instance of the TodoApp class.
+    """
+    app = TodoApp(file_path_to_json=file_path_to_json)
+    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_json=filepath)
+    app.add_todo(item)
+    app.list_todos()
+    app.write_todos()
+
+
+def list_items_on_list(filepath: str):
+    """
+    List all items in the todo list.
+
+    Parameters
+    ----------
+    filepath : str
+        The file path to the JSON file for storing todos.
+    """
+    app = create_list(file_path_to_json=filepath)
+    app.list_todos()
+
+
+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_json=filepath)
+    app.remove_todo(index)
+    app.list_todos()
+    app.write_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_json=filepath)
+    app.todos = []
+    print("Cleared all todos.")
+    app.write_todos()
+
+
+def cli_menu(filepath="./.todo_list.json"):
+    """
+    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.json"
+    """
+    app = create_list(file_path_to_json=filepath)
+    while True:
+        action = questionary.select(
+            "What would you like to do?",
+            choices=[
+                "Add todo",
+                "List todos",
+                "Remove todo",
+                "Clear all todos",
+                "Exit",
+            ],
+        ).ask()
+
+        if action == "Add todo":
+            item = questionary.text("Enter the todo item:").ask()
+            app.add_todo(item)
+            app.write_todos()
+        elif action == "List todos":
+            app.list_todos()
+        elif action == "Remove todo":
+            if not app.todos:
+                print("No todos to remove.")
+                continue
+            todo_choice = questionary.select(
+                "Select the todo to remove:",
+                choices=["<Back>"] + app.todos,
+            ).ask()
+
+            if todo_choice == "<Back>":
+                continue
+
+            todo_to_remove = app.todos.index(todo_choice) + 1
+            app.remove_todo(todo_to_remove)
+            app.write_todos()
+
+        elif action == "Clear all todos":
+            confirm = questionary.confirm(
+                "Are you sure you want to clear all todos?"
+            ).ask()
+            if confirm:
+                app.todos = []
+                print("Cleared all todos.")
+                app.write_todos()
+        elif action == "Clear all todos":
+            confirm = questionary.confirm(
+                "Are you sure you want to clear all todos?"
+            ).ask()
+            if confirm:
+                app.todos = []
+                print("Cleared all todos.")
+                app.write_todos()
+        elif action == "Exit":
+            break
+        else:
+            break

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

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: cli-todo-jd
+Version: 0.1.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
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: bump-my-version; extra == "dev"
+
+# cli-todo-jd
+
+A command line to do list with interactive menu
+
+## Getting started
+
+To start using this project, first make sure your system meets its
+requirements.
+
+It's suggested that you install this package and its requirements within
+a virtual environment.
+
+## Requirements
+
+- Python 3.9+ installed
+
+## Installing the package
+
+Whilst in the root folder, in a terminal, you can install the package and its
+Python dependencies using:
+
+```shell
+python -m pip install -U pip setuptools
+pip install -e .
+```
+
+### Install for contributors/developers
+
+To install the contributing requirements, use:
+```shell
+python -m pip install -U pip setuptools
+pip install -e .[dev]
+pre-commit install
+```
+
+This installs an editable version of the package. This means that when you update the
+package code you do not have to reinstall it for the changes to take effect.
+This saves a lot of time when you test your code.
+
+Remember to update the setup and requirement files inline with any changes to your
+package.
+
+
+## Licence
+
+Unless stated otherwise, the codebase is released under the MIT License. This covers
+both the codebase and any sample code in the documentation.
+
+## Contributing
+
+If you want to help us build and improve `{{ cookiecutter.project_slug }}`, please take a look at our
+[contributing guidelines][contributing].
+
+## Acknowledgements
+
+This project structure is based on the [`govcookiecutter` template project][govcookiecutter].
+
+[contributing]: https://github.com/best-practice-and-impact/govcookiecutter/blob/main/%7B%7B%20cookiecutter.repo_name%20%7D%7D/docs/contributor_guide/CONTRIBUTING.md
+[govcookiecutter]: https://github.com/best-practice-and-impact/govcookiecutter

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

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+cli_todo_jd/__init__.py
+cli_todo_jd/cli_entry.py
+cli_todo_jd/main.py
+cli_todo_jd.egg-info/PKG-INFO
+cli_todo_jd.egg-info/SOURCES.txt
+cli_todo_jd.egg-info/dependency_links.txt
+cli_todo_jd.egg-info/entry_points.txt
+cli_todo_jd.egg-info/requires.txt
+cli_todo_jd.egg-info/top_level.txt

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,6 @@
+[console_scripts]
+todo_add = cli_todo_jd.cli_entry:add_item
+todo_clear = cli_todo_jd.cli_entry:clear_list
+todo_list = cli_todo_jd.cli_entry:list_items
+todo_menu = cli_todo_jd.main:cli_menu
+todo_remove = cli_todo_jd.cli_entry:remove_item

cli_todo_jd-0.1.0/cli_todo_jd.egg-info/requires.txt

@@ -0,0 +1,7 @@
+questionary>=2.1.1
+rich>=14.2.0
+
+[dev]
+pre-commit
+pytest
+bump-my-version

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

@@ -0,0 +1 @@
+cli_todo_jd

cli_todo_jd-0.1.0/pyproject.toml

@@ -0,0 +1,46 @@
+[project]
+name = "cli-todo-jd"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "questionary>=2.1.1",
+    "rich>=14.2.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit",
+    "pytest",
+    "bump-my-version"
+]
+
+[project.scripts]
+todo_add = "cli_todo_jd.cli_entry:add_item"
+todo_remove = "cli_todo_jd.cli_entry:remove_item"
+todo_list = "cli_todo_jd.cli_entry:list_items"
+todo_clear = "cli_todo_jd.cli_entry:clear_list"
+todo_menu =  "cli_todo_jd.main:cli_menu"
+
+[tool.bumpversion]
+current_version = "0.1.0"
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
+serialize = ["{major}.{minor}.{patch}"]
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+ignore_missing_version = false
+ignore_missing_files = false
+tag = true
+sign_tags = false
+tag_name = "v{new_version}"
+tag_message = "Bump version: {current_version} → {new_version}"
+allow_dirty = false
+commit = true
+message = "Bump version: {current_version} → {new_version}"
+moveable_tags = []
+commit_args = "--no-verify"
+setup_hooks = []
+pre_commit_hooks = []
+post_commit_hooks = []

cli_todo_jd-0.1.0/setup.cfg

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