final changes

Author: MXD-K1

README.md

@@ -1,6 +1,8 @@
 # CLI Task Tracker
 
-CLI Task Tracker is a simple yet powerful command-line application designed to help you manage your tasks directly from your terminal. Built entirely in Python, the project uses only built-in modules (`json`, `sys`, and `datetime`), ensuring a lightweight solution with no external dependencies.
+CLI Task Tracker is a simple yet powerful command-line application designed to help you manage your tasks directly 
+from your terminal. Built entirely in Python, the project uses only built-in modules (`json`, `sys`, and `datetime`),
+ensuring a lightweight solution with no external dependencies.
 
 ## Table of Contents
 - [Overview](#overview)
@@ -36,11 +38,67 @@ No additional packages are required since only built-in modules are used.
 ### Steps to Install
 1. **Clone the Repository:**
    ``` bash
-   git clone https://github.com/yourusername/cli-task-tracker.git
+   git clone https://github.com/MXD-K1/cli-task-tracker.git
    cd cli-task-tracker
    ```
+2. **Run it on your terminal:**
+    ``` bash
+    python task-tarcker-cli.py # your commands go here
+    ```
+
 ## Usage
-none
+Here is a list of the available commands:
+   1. **Adding a Task:**
+      - To add a new task, simply use:
+      ``` bash
+      python cli_task_tracker.py add "Buy groceries"
+      ```
+      Output: `Successfully added Buy groceries (ID: 3)`
+      
+      - To add a description to an existing task:
+      ``` bash
+      python cli_task_tracker.py add 3 -d "Buy groceries and cook diner"
+      ```
+      
+      - To add a description to a new task:
+      ``` bash
+      python cli_task_tracker.py add "Buy groceries" -d "Buy groceries and cook diner
+      ```
+   
+   2. **Updating a Task:**
+      - To add a new task, simply use:
+      ``` bash
+      python cli_task_tracker.py update 1 "Buy groceries and cook diner"
+      ```
+      
+   3. **Deleting a Task:**
+       
+      Remove a task using its ID:
+      ``` bash
+      python cli_task_tracker.py delete 1
+      ```
+   4. **Listing Tasks:**
+      - View all tasks:
+      ``` bash
+      python cli_task_tracker.py list
+      ```
+      - Filter tasks by status:
+      ``` bash
+      python cli_task_tracker.py list todo
+      python cli_task_tracker.py list in-progress
+      python cli_task_tracker.py list done
+      ```  
+   5. **Marking Tasks (Changing Task Status):**
+      - Mark a task as in-progress:
+      ``` bash
+      python cli_task_tracker.py mark-in-progress 1
+      ```
+      - Mark a task as either `todo`, `in-progress`, or `done`:
+      ``` bash
+      python cli_task_tracker.py mark 1 done
+      python cli_task_tracker.py mark 1 todo
+      python cli_task_tracker.py mark 1 in-progress
+      ```
 
 ## Task Data Structure
 Each task is stored in a JSON file with the following properties:
@@ -79,31 +137,30 @@ Thank you for considering contributing to **CLI Task Tracker**! Your contributio
    ``` bash
    git checkout -b feature/your-feature-name
    ```
-
-   When making your changes:
+4. **Make Your Changes:**
    - Ensure your code follows the project’s style.
    - Write clear, concise commit messages.
    - Update documentation **if** needed.
 
-4. **Commit Your Changes**:
-
-``` bash
-git commit -am "Add [feature/bug fix]: Brief description of changes"
-``` 
-Push Your Branch:
-
-bash
-git push origin feature/your-feature-name
-Open a Pull Request (PR):
-
-Navigate to the original repository on GitHub.
-
-Open a new PR and describe your changes in detail.
-
-Link to any related issues and explain why your contribution is valuable.
+5. **Commit Your Changes:**
+   ``` bash
+   git commit -am "Add [feature/bug fix]: Brief description of changes"
+   ``` 
+6. **Push Your Branch:**
+   
+   ``` bash
+   git push origin feature/your-feature-name
+   ```
+7. **Open a Pull Request (PR):**
+   - Navigate to the original repository on GitHub.
+   - Open a new PR and describe your changes in detail.
+   - Link to any related issues and explain why your contribution is valuable.
 
-Code Style and Standards
+### Code Style and Standards
 
+   - Follow the established code style for the project.
+   - Test your changes thoroughly before submitting a PR.
+   - Keep commits focused and descriptive.
 
 ## License
 This project is licensed under the **MIT License** – a permissive open-source license that allows users to freely use,

cli_task_tracker.py

@@ -3,18 +3,12 @@
 import json
 import sys
 from typing import Dict
-
 import datetime
 
 
-# fix bugs
-# help is not tested yet
-
-
 def main():
     json_file = "tasks.json"
     args, do = extract_args()
-    print(args)
 
     # perform the task
     execute_command(args, do, json_file)
@@ -38,7 +32,7 @@ def extract_args():  # Needs refactoring
                 args["args"] = [task]
             elif len(raw_args) == 4:
                 task_id_or_task = raw_args[1]
-                args["args"] = [task_id_or_task]
+                args["args"] = [int(task_id_or_task) if task_id_or_task.isdigit() else task_id_or_task]
                 if "-d" == raw_args[2]:
                     description = raw_args[3]
                     args["args"].append(description)
@@ -197,29 +191,27 @@ def extract_args():  # Needs refactoring
 def execute_command(args, do, json_file):
     data = get_data(json_file)
     task_id = get_id(data)
-    if args["command"] == "add":
-        if do:
+    if do:
+        if args["command"] == "add":
             if len(args["args"]) == 1:
-                add_task(args["args"][0], task_id, data,  json_file)
+                add_task(args["args"][0], task_id, data, json_file)
             else:
-                add_description(1, data, 11, json_file)
-    elif args["command"] == "delete":
-        if do:
+                if isinstance(args["args"][0], int):
+                    add_description(args["args"][1], args["args"][0], data, json_file)
+                else:  # It will be a str
+                    add_task(args["args"][0], task_id, data, json_file)
+                    add_description(args["args"][1], task_id, data, json_file)
+        elif args["command"] == "delete":
             delete_task(args["args"][0], data, json_file)
-    elif args["command"] == "update":
-        if do:
+        elif args["command"] == "update":
             update_task(args["args"][0], args["args"][1], data, json_file)
-    elif args["command"] == "list":
-        if do:
+        elif args["command"] == "list":
             list_tasks(data, args["args"][0])
-    elif args["command"] == "mark":
-        if do:
+        elif args["command"] == "mark":
             mark_task(data, args["args"][0], args["args"][1], json_file)
-    else:
-        pass
-        # No need to do anything, because extract_args reports error and ignore the invalid command
-
-    # then (8) add the rest of the features from roadmap like adding time ...
+        else:
+            pass
+            # No need to do anything, because extract_args reports error and ignore the invalid command
 
 
 def get_data(json_file):
@@ -256,12 +248,13 @@ def add_task(item, task_id, data, json_file):
 
 def add_description(description, task_id, data, json_file):
     if data.get(f"t{task_id}", None) is not None:
-        data[f"t{task_id}"]["updateAt"] = datetime.datetime.now().strftime("%d-%m-%Y %H:%M:%S")
+        data[f"t{task_id}"]["UpdatedAt"] = datetime.datetime.now().strftime("%d-%m-%Y %H:%M:%S")
         data[f"t{task_id}"]["description"] = description
         write_to_json(json_file, data)
         print(f"Successfully added description for {data[f"t{task_id}"]["task"]} (ID: {task_id})")
     else:
-        report_error()
+        report_error(f"No task is associated with the ID {task_id}.", "ID")
+
 
 def delete_task(task_id, data, json_file):
     try:

cli_task_tracker.pyi

@@ -8,7 +8,7 @@ def get_data(json_file: str) -> Dict: ...
 def get_id(data: Dict) -> int: ...
 def write_to_json(file_name: str, data: Dict) -> None: ...
 def add_task(item: str, task_id: int, data: Dict, json_file: str) -> None: ...
-def add_description(item: str, task_id: int, data: Dict, json_file: str) -> None: ...
+def add_description(description: str, task_id: int, data: Dict, json_file: str) -> None: ...
 def delete_task(task_id: int, data: Dict, json_file: str) -> None: ...
 def update_task(task_id: int, new_task: str, data: Dict, json_file: str) -> None: ...
 def sort_dict_data(task_dict: Tuple[str, Dict[str, Any]]) -> None: ...