https://github.com/yosephdev/task-master

A Python command-line application designed to help users organize and manage their tasks efficiently.
https://github.com/yosephdev/task-master

heroku productivity python3 task-management

Last synced: 5 months ago
JSON representation

A Python command-line application designed to help users organize and manage their tasks efficiently.

• Host: GitHub
• URL: https://github.com/yosephdev/task-master
• Owner: yosephdev
• Created: 2024-02-06T07:54:43.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-04T16:55:19.000Z (almost 2 years ago)
• Last Synced: 2025-01-22T14:37:09.522Z (over 1 year ago)
• Topics: heroku, productivity, python3, task-management
• Language: Python
• Homepage: https://task-master-f87866ccc6e2.herokuapp.com/
• Size: 305 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Task Master

Task Master is a Python command-line application designed to help users organize and manage their tasks efficiently. It provides a user-friendly interface where users can add, update, list, and delete tasks. The application utilizes basic data structures such as lists and dictionaries to store task information and incorporates file I/O operations for persistent data storage.

![Here is the live version of my project.](./docs/responsive-mockup.png)

## Table of Contents

- [Task Master](#task-master)

  - [Project Overview](#project-overview)

  - [Main Technologies](#main-technologies)

  - [Features](#features)

    - [App Overview](#app-overview)

    - [Screenshots](#screenshots)

    - [Implemented Features](#implemented-features)

    - [How to Use](#how-to-use)

  - [Core Logic for Managing Tasks](#core-logic-for-managing-tasks)

  - [Documentation](#documentation)

  - [Testing](#testing)

  - [Bugs](#bugs)

  - [Validator Testing](#validator-testing)

  - [Deployment](#deployment)

  - [Credits](#credits)

## Project Overview

Task Master is developed to provide users with a simple yet effective tool for managing their tasks. The project aims to enhance productivity and organization by offering essential task management functionalities through a command-line interface.

## Main Technologies

Task Master primarily utilizes core Python functionalities for its implementation.

### Features

### App Overview

Task Master presents a menu-driven interface with options for adding, updating, listing, and deleting tasks. Users interact with the application through intuitive commands, making task management seamless and efficient.

### Screenshots

#### Figure 1: Task Management Application - Main Menu

![Main Menu](./docs/main-menu.png)

##### Figure 2: Task Management Application - Menu-Driven Interface Flowchart

![Menu-Driven Interface](./docs/interface-flowchart.png)

##### Figure 3: Task Management Application - Add Task

![Add Task](./docs/add-task.png)

### Implemented Features

1. **Task Deadlines:** Users can now add deadlines to tasks, allowing for better task tracking and time management.

2. **Adding Tasks:** Users can add new tasks to the task list, providing a title, description, and optional deadline.

3. **Updating Tasks:** Users can update existing tasks, modifying their title, description, status, or deadline as needed.

4. **Listing Tasks:** Users can view a list of all tasks, including their titles, descriptions, statuses, and deadlines.

5. **Deleting Tasks:** Users can delete tasks from the task list, removing them permanently.

6. **Task Filtering and Sorting:** Users can filter and sort tasks based on criteria such as priority, due date, and status.

## Libraries Used

Task Master makes use of the following Python libraries to enhance its functionality:

- **os**: Utilized for handling file I/O operations, allowing Task Master to store and retrieve task data from local storage.

  

- **json**: Employed for serializing and deserializing task data to and from JSON format, enabling persistent storage of tasks in a structured manner.

- **datetime**: Used for handling date and time-related operations, particularly for managing task deadlines effectively.

- **gspread**: Integrated for interacting with Google Sheets, facilitating seamless integration with online spreadsheets for task management.

- **google.oauth2.service_account**: Used in conjunction with gspread for authentication and authorization when accessing Google Sheets.

- **re**: Employed for regular expression-based validation, ensuring data integrity and format adherence in certain input fields.

These libraries were selected for their compatibility with Python and their ability to streamline essential functionalities required for task management in Task Master.

## How to Use

To use Task Master, follow these steps:

1. Select the desired option from the menu to perform specific tasks, such as adding, updating, listing, or deleting tasks.

2. Input the required information as prompted by the application.

3. Follow the on-screen instructions to navigate through the various functionalities of Task Master.

## Core Logic for Managing Tasks

The core logic for managing tasks is implemented within the Python script. This includes functions for adding tasks, updating task status, listing tasks, and deleting tasks. Basic data structures such as lists and dictionaries are used to store task information.

## Documentation

The codebase is documented with comments to explain the purpose and functionality of each function or section.

## Testing

I have manually tested Task Master by performing the following steps:

1. Passed the code through the Python linter and confirmed there are no syntax or style problems.

2. Provided invalid inputs, such as strings where integers are expected, out-of-bound inputs, and duplicate inputs for various operations like adding, updating, listing, or deleting tasks. Ensured that the application handles invalid inputs gracefully and displays appropriate error messages.

3. Tested different combinations of task data, including various titles, descriptions, and statuses, to ensure that tasks are added, updated, listed, and deleted accurately.

4. Checked for each outcome of the task management operations to verify if the correct output is displayed. Ensured that tasks are manipulated as expected and that the application behaves correctly in all scenarios.

5. Verified the functionality for multiple task management sessions to ensure that the tasks are persisted correctly between sessions and that the application maintains accurate task data.

## Bugs

- **Deadline Format Validation:** The application allows users to input any format for the deadline. It should enforce a strict format (YYYY-MM-DD) and reject any other format.

  

- **Deleting Last Task:** If the user deletes the last task, the application crashes because there's no row to delete. It should display a message informing the user that there are no tasks to delete.

## Validator Testing

No errors were returned from the pep8ci.herokuapp.com

## Deployment

Task Master has been successfully deployed using Heroku. Follow these steps to deploy the app:

1. Clone this repository: .

2. Create a new Heroku app.

3. Set the config vars key PORT and value 8000.

4. Set the build packs to Python and NodeJS in that order.

5. Link the Heroku app to the repository.

6. Click on deploy.

## Credits

- [Mitko Bachvarov](https://www.linkedin.com/in/mitko-bachvarov-40b50776/) for project guidance and feedback.

- Credits to [Code Institute](https://www.codeinstitute.net) for the deployment terminal

- Credits to the Python community for providing valuable resources for Python development.