geekcomputers / geekcomputers/Python

Task Breakdown

Open
#2,382 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
35.4k
Forks
12.9k
Avg merge
2h 37m
Merged PRs (30d)
1

Description

1)Set Up Your Environment:

Ensure Python is installed on your machine.
You can check this by running:
bash
Copy code
python --version
Project Structure:

Create a directory for the project named todo_app.

Inside it, create the following files:

todo.py: This will contain the main application logic.
tasks.json: This will store the tasks in JSON format.
README.md: Add documentation.
Your file structure should look like this:

bash
Copy code
/todo_app
├── todo.py # Main application logic
├── tasks.json # File to store tasks
└── README.md # Documentation
Implement Core Features:

2)Task Class:

Define a Task class that represents individual tasks in the app. This class should handle the creation of tasks and the ability to mark them as completed:
python
Copy code
class Task:
def init(self, title, description, category):
self.title = title
self.description = description
self.category = category
self.completed = False

def mark_completed(self):
    self.completed = True

3)File Handling:

Use Python's json module to store tasks in a tasks.json file. This allows persistence across runs of the application.

Code to save tasks:

python
Copy code
import json

def save_tasks(tasks):
with open('tasks.json', 'w') as f:
json.dump([task.dict for task in tasks], f)
Code to load tasks:

python
Copy code
def load_tasks():
try:
with open('tasks.json', 'r') as f:
return [Task(**data) for data in json.load(f)]
except FileNotFoundError:
return []
4)User Interaction:

Implement a simple command-line interface (CLI) to interact with the user. This will include options to add a task, view tasks, mark tasks as completed, delete tasks, and exit the application.
Here's a sample implementation of the main() function:

python
Copy code
def main():
tasks = load_tasks()
while True:
print("1. Add Task")
print("2. View Tasks")
print("3. Mark Task Completed")
print("4. Delete Task")
print("5. Exit")

    choice = input("Choose an option: ")

    if choice == '1':
        # Add task
        title = input("Title: ")
        description = input("Description: ")
        category = input("Category: ")
        tasks.append(Task(title, description, category))
    elif choice == '2':
        # View tasks
        for idx, task in enumerate(tasks, 1):
            status = "Completed" if task.completed else "Incomplete"
            print(f"{idx}. {task.title} - {status}")
    elif choice == '3':
        # Mark task as completed
        task_num = int(input("Enter task number to mark as completed: "))
        tasks[task_num - 1].mark_completed()
    elif choice == '4':
        # Delete task
        task_num = int(input("Enter task number to delete: "))
        del tasks[task_num - 1]
    elif choice == '5':
        save_tasks(tasks)
        break

5)Testing and Documentation:

Thoroughly test your app by adding, viewing, marking, and deleting tasks.
Document the purpose of the app and how to use it in the README.md file.
README.md Example:
markdown
Copy code

To-Do App

A simple command-line To-Do list manager built with Python.

Features:

  • Add tasks with titles, descriptions, and categories.
  • View tasks and their completion status.
  • Mark tasks as completed.
  • Delete tasks.
  • Save tasks to a JSON file for persistence.

Usage:

  1. Run the application:
    python todo.py
    

Follow the on-screen instructions to manage your tasks.
sql
Copy code

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the requested todo_app structure: todo.py, tasks.json, and README.md. Verify the Python setup with python --version, then run python todo.py while checking add, view, completion, deletion, exit, and persistence behavior. Done means the described CLI features work and the README documents the app and usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.