Skip to content

README.md

Latest commit

 

History

History
165 lines (115 loc) · 3.17 KB

README.md

File metadata and controls

165 lines (115 loc) · 3.17 KB

TaskMate 📝

A Python-based CLI Task Manager

Python
License

A command-line task manager built with Python, Argparse, Tabulate and Datetime.
It allows you to create, read, update, delete, sort, and mark tasks directly from the terminal.
All tasks are stored locally in a JSON file

“This project was built to strengthen my understanding of Python functions and the argparse module.”

Features :

  • Add tasks with optional details like description, status, and priority

  • Easily update or modify existing tasks

  • Track progress by marking tasks as todo, in-progress, or done

  • View tasks in a table and sort them by status or priority

  • Remove tasks individually or clear your entire task list

  • Simple and intuitive CLI commands

  • JSON storage for easy management

📦 Installation :

  1. clone this repo anywhere
  2. Give executable permission
  3. create a Symlink of this repo to ~/.local/bin
> git clone https://VigneshwaranK08//TaskMate.git
> chmod +x TaskMate.py # ( after > cd TaskMate)
> sudo ln -s <path where u cloned>/TaskMate/TaskMate.py ~/.local/bin/taskmate
Click to view the usage guide

Usage📖 :

Here are the main commands TaskMate supports:

  • Add a Task
taskmate add <TaskName>

(optional)

taskmate add <TaskName> -d <description> -s <status> -p <priority>

Note : status only accepts ['in-progress','done','todo'] defult = todo

Priority only accepts ["low","medium","high"] default="low"

  • Update a Task

    • Update Name
    taskmate update <TaskId> -n <NewTaskName>
    • Update Description
    taskmate update <TaskId> -d <NewTaskDescription>
    • Update Priority
    taskmate update <TaskId> -p <NewTaskPriority>

Note: All the above 3 flags can also be used at the same time

  • List Tasks

    • List All Task
    taskmate list
    • List Task Based on their Status
    taskmate List done 

    taskmate List in-progress 

    taskmate List todo

  • Delete Task's

    • Delete Task By Providing Their Id
    taskmate delete <TaskId>
    • Delete all Task
    taskmate delete

  • Change the Status of a Task

taskmate mark <TaskId> <NewStatus>

The New Status only accepts done , todo , in-progress

  • Veiw Sort the Tasks

  • Sort Tasks based on their Status

    • todo - in-progress -done
    taskmate sort -s
    • done - in-progress - done
    taskmate sort -S

  • Sort Tasks based on their Priority

    • high - medium - low
    taskmate sort -p
    • low - medium - high
    taskmate sort -P

Project Structure 📂:

TaskMate/
|-- TaskMate.py
|-- README.md
|-- .gitignore
|-- LICENSE

🙌 Acknowledgements

Special thanks to: