cli-todo-jd 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

cli_todo_jd/cli_entry.py

@@ -4,6 +4,7 @@ from cli_todo_jd.main import (
     remove_item_from_list,
     list_items_on_list,
     clear_list_of_items,
+    cli_menu,
 )
 
 
@@ -73,3 +74,11 @@ def clear_list():
 
     # assuming remove_item_from_list(0/None) clears; otherwise replace with your clear implementation
     clear_list_of_items(args.filepath)
+
+
+def todo_menu():
+    parser = ArgumentParser(description="Todo List CLI Menu")
+    parser_optional_args(parser)
+    args = parser.parse_args()
+
+    cli_menu(filepath=args.filepath)

{cli_todo_jd-0.1.0.dist-info → cli_todo_jd-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cli-todo-jd
-Version: 0.1.0
+Version: 0.1.1
 Summary: Add your description here
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
@@ -15,6 +15,27 @@ Requires-Dist: bump-my-version; extra == "dev"
 
 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. 
+
+### `todo-menu`
+
+Once installed us `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`.
+
+
+### interacting with todo list without menu
+
+Alternatly 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)
+
 ## Getting started
 
 To start using this project, first make sure your system meets its

cli_todo_jd-0.1.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+cli_todo_jd/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cli_todo_jd/cli_entry.py,sha256=WFigVsmponzukNW-T_35ChdMWS3AVerdfKp2MePZzVo,2109
+cli_todo_jd/main.py,sha256=PfzsSz6whW8BMQ79PoCRvJO5oBN7qhpDFut_HtgjJns,5877
+cli_todo_jd-0.1.1.dist-info/METADATA,sha256=PhFUYCFtAyTd5u_CQ-b5Pn1K6Q_5nvYlxNcqigRLoWs,2951
+cli_todo_jd-0.1.1.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+cli_todo_jd-0.1.1.dist-info/entry_points.txt,sha256=UtqZ1yqzeQNOOVC232_iqRQCcKu9hL9k5Q-BtyMZSGg,243
+cli_todo_jd-0.1.1.dist-info/top_level.txt,sha256=hOnYr7w1JdQs6MlD1Uzjt24Ca8nvriOWNNq6NaqgHqM,12
+cli_todo_jd-0.1.1.dist-info/RECORD,,

{cli_todo_jd-0.1.0.dist-info → cli_todo_jd-0.1.1.dist-info}/entry_points.txt

@@ -2,5 +2,5 @@
 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_menu = cli_todo_jd.cli_entry:todo_menu
 todo_remove = cli_todo_jd.cli_entry:remove_item

cli_todo_jd-0.1.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-cli_todo_jd/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cli_todo_jd/cli_entry.py,sha256=hchk50z0fLwJXp0EtJnOQJnL_N3epapri3oRfHubHW4,1912
-cli_todo_jd/main.py,sha256=PfzsSz6whW8BMQ79PoCRvJO5oBN7qhpDFut_HtgjJns,5877
-cli_todo_jd-0.1.0.dist-info/METADATA,sha256=6arB2OpzkroM2RRWft3eYyuJKsXA0s1VRAuU8HmySN0,2044
-cli_todo_jd-0.1.0.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
-cli_todo_jd-0.1.0.dist-info/entry_points.txt,sha256=pt-uqvxVlLV4OWzK-fnEG9O5TtVB_aEwO1QEDYAhx5I,237
-cli_todo_jd-0.1.0.dist-info/top_level.txt,sha256=hOnYr7w1JdQs6MlD1Uzjt24Ca8nvriOWNNq6NaqgHqM,12
-cli_todo_jd-0.1.0.dist-info/RECORD,,