Skip to content

Latest commit

 

History

History
136 lines (85 loc) · 2.62 KB

README.md

File metadata and controls

136 lines (85 loc) · 2.62 KB

Task Tracker CLI

home

A simple yet efficient task tracker that allows you to manage your tasks from the command line. Task Tracker CLI helps you organize and keep track of your daily tasks, allowing you to add, update, delete, and change task statuses directly from the terminal.

Features

  • Add Tasks: Add a task with a given description.
  • List Tasks: Display all tasks with their ID, description, and status.
  • Update Tasks: Update the description of an existing task.
  • Delete Tasks: Delete a task by its ID.
  • Change Task Status: Change the status of a task to "to-do", "in-progress", or "done".

Requirements

  • Python 3.6 or higher.

Installation

  1. Clone the repository:
git clone https://github.com/Jonatanciencias/task_tracker_cli.git
  1. Navigate to the directory:
cd task_tracker_cli
  1. Set up a virtual environment (optional but recommended):
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install the project using setup.py:
pip install .
  1. Run help
task-cli help

Usage

Commands:

  1. Add Task:
task-cli add "Task description"
  1. List Tasks:
task-cli list
  1. List Tasks by Status:
task-cli list done
task-cli list todo
task-cli list in-progress
  1. Update Task:
task-cli update <ID> "New description"
  1. Delete Task:
task-cli delete <ID>
  1. Change Status:
task-cli new_status <ID> <status>
  1. Uninstal:
pip uninstall task-tracker-cli

Testing

Unit tests are included to ensure the core functions work correctly. To run the tests:

python -m unittest discover tests

Important Notice:

If you encounter no output or an error in the console while using the Task Tracker CLI, you can find detailed logs for troubleshooting.

  1. Log Location: Logs are automatically saved in the following directory within your virtual environment:
\venv\Lib\site-packages\logs
  1. Checking Logs: If the CLI does not behave as expected or an error occurs, check the utils.log file inside the logs folder for detailed information

Original Project

This project is an implementation of the Task Tracker CLI, based on the projects proposed by roadmap.sh.

Contributions

Contributions are welcome! Please open an issue or submit a pull request.

Repositorio GitHub:

https://github.com/Jonatanciencias/task_tracker_cli