Todo CLI

A simple and effective Command-Line Interface (CLI) application to manage tasks. This Task Manager allows you to add, list, complete, and remove tasks with varying priorities. Tasks are stored in a JSON file, making it easy to persist and manage your tasks over time.

Features

• Add Tasks: Add new tasks with a priority level (Low, Medium, or High).
• List Tasks: View all tasks sorted by their priority.
• Complete Tasks: Mark tasks as completed.
• Remove Tasks: Remove tasks from the list.

Requirements

• Python 3.6 or higher
• click library

Installation and Setup

1. Clone the repository:

   git clone https://github.com/kanishkdhebana/Todo_CLI
   cd Todo_CLI

2. Install the required packages:

   Install the dependencies using pip:

   pip install click

3. Make the script executable:

   If you want to run the script directly:

   chmod +x todo.py

4. Add alias to .bashrc or .zshrc:

   Add this line to .bashrc or .zshrc to create a convenient alias for the script:

   alias todo='python /path/to/todo.py'

   Replace /path/to/todo.py with the actual path to the todo.py file.

5. Reload your shell configuration:

   After adding the alias, reload your shell configuration to apply the changes:

   source ~/.bashrc   # For bash users
   source ~/.zshrc    # For zsh users

Usage

Once you have set up the alias, you can use the todo command to interact with the Task Manager CLI.

Adding a Task

To add a new task, use the add command followed by the task description and an optional priority flag:

todo add "Buy groceries" -p h

or

todo add "Buy groceries" --priority h

This command adds a new task "Buy groceries" with High priority.

Listing All Tasks

To list all tasks, use the list command:

todo list

Completing a Task

To mark a task as complete, use the complete command followed by the task index:

todo complete 1

This will mark the first task as complete.

Removing a Task

To remove a task, use the remove command followed by the task index:

todo remove 1

This will remove the first task from your list.

Priority Levels

• Low (l): Tasks with low importance.
• Medium (m): Tasks with medium importance. (Default)
• High (h): Tasks with high importance.

File Structure

• task_manager.py: The main Python script containing the task manager CLI.
• tasks.json: The JSON file where tasks are stored.

Error Handling

• File Not Found: If the tasks.json file is not found, a new file is created automatically.
• Invalid Task Index: If you try to complete or remove a task that does not exist, an error message will be displayed.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an issue.