Skip to content

Commit c10f123

Browse files
Revise README for Advanced To-Do List Application
Updated README to enhance project description and features.
1 parent b2d9db5 commit c10f123

File tree

1 file changed

+107
-48
lines changed

1 file changed

+107
-48
lines changed

To-Do-list/README.md

Lines changed: 107 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,138 @@
1-
# ✅ To-Do List Application (Python)
2-
1+
<h1 align="center"> Advanced To-Do List Application (Python)</h1>
2+
3+
<p align="center">
4+
A modern, interactive, and beginner-friendly <b>Command-Line To-Do List App</b> written in <b>Python</b> .
5+
Manage your daily tasks efficiently — add, view, complete, and delete tasks — all from your terminal!
6+
Built with scalability, simplicity, and future upgrades in mind.
7+
</p>
8+
9+
<p align="center">
10+
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/Python-3.10%2B-blue?style=for-the-badge&logo=python"></a>
11+
<a href="https://code.visualstudio.com/"><img src="https://img.shields.io/badge/Editor-VS%20Code-0078D4?style=for-the-badge&logo=visualstudiocode&logoColor=white"></a>
12+
<a href="https://github.com/mantrapatil03/python-beginner-friendly-projects/stargazers"><img src="https://img.shields.io/github/stars/mantrapatil03/python-beginner-friendly-projects?style=for-the-badge&logo=github"></a>
13+
<a href="https://github.com/mantrapatil03/python-beginner-friendly-projects/network/members"><img src="https://img.shields.io/github/forks/mantrapatil03/python-beginner-friendly-projects?style=for-the-badge&logo=git"></a>
14+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-green?style=for-the-badge&logo=opensourceinitiative&logoColor=white"></a>
15+
<a href="#"><img src="https://img.shields.io/badge/PRs-Welcome-brightgreen?style=for-the-badge&logo=github"></a>
16+
</p>
317

18+
---
419

20+
## Key Features
521

6-
A clean and lightweight **command-line To-Do List application** written in Python.
7-
Manage your tasks efficiently with options to add, view, mark as complete, and delete — all from your terminal.
22+
- **View All Tasks** – Instantly see all your tasks with status icons (`[✔]` or `[✗]`)
23+
- **Add Tasks** – Add unlimited tasks dynamically
24+
- **Mark as Completed** – Update task progress easily
25+
- **Delete Tasks** – Remove finished or unnecessary items
26+
- **Auto Save (Upcoming)** – Persist tasks in a local `.json` or `.csv` file
27+
- **Priority Levels (Upcoming)** – Assign high/medium/low importance tags
28+
- **Due Date Tracking (Upcoming)** – Stay ahead of deadlines
29+
- **Colorful UI** – Optional color themes for a better CLI experience
30+
- **Exit Gracefully** – Clean shutdown and data handling
831

932
---
1033

11-
## ✨ Features
12-
- 📋 **View Tasks** – See all tasks with their completion status.
13-
-**Add Tasks** – Add new tasks with custom descriptions.
14-
- ✔️ **Mark Tasks as Completed** – Update the status of any task.
15-
- 🗑️ **Delete Tasks** – Remove completed or unwanted tasks.
16-
- 🚪 **Exit Application** – Close the program gracefully.
34+
## Tech Stack
35+
36+
| Technology | Purpose |
37+
|-------------|----------|
38+
| **Python 3** | Core logic and CLI |
39+
| **os & sys modules** | Handle input/output and screen clearing |
40+
| **JSON / CSV (future)** | Data persistence |
41+
| **Colorama (optional)** | Add color to CLI output |
1742

1843
---
1944

20-
## 🚀 Getting Started
45+
## Installation & Setup
2146

22-
### 🔧 Prerequisites
23-
- Python **3.x** installed on your system.
47+
### Prerequisites
48+
Make sure you have **Python 3.10+** installed:
49+
```bash
50+
python --version
51+
```
2452

25-
### ▶️ Run the Script
26-
1. Clone this repository:
27-
```bash
28-
git clone https://github.com/mantrapatil03/python-beginner-friendly-projects/todo-list.git
29-
30-
cd todo-list
31-
32-
Run the app:
53+
## Run the Application
3354
```
55+
# Clone the repository
56+
git clone https://github.com/mantrapatil03/python-beginner-friendly-projects.git
57+
58+
# Navigate to the To-Do List project
59+
cd python-beginner-friendly-projects/todo-list
60+
61+
# Run the app
3462
python todo.py
3563
```
3664

37-
📌 Example Usage
65+
> ptional: Install `colorama` for colored terminal output
66+
> ```
67+
> pip install colorama
68+
> ```
3869
70+
### Example Demo
3971
```
40-
mathematica
41-
42-
To-Do List Menu:
43-
1. View tasks
44-
2. Add task
45-
3. Mark task as completed
46-
4. Delete task
72+
✅ To-Do List Menu
73+
─────────────────────────────
74+
1. View Tasks
75+
2. Add Task
76+
3. Mark Task as Completed
77+
4. Delete Task
4778
5. Exit
79+
─────────────────────────────
4880
Choose an option: 2
49-
Enter task description: Finish Python project
50-
Task added.
51-
52-
To-Do List Menu:
53-
1. View tasks
54-
2. Add task
55-
3. Mark task as completed
56-
4. Delete task
57-
5. Exit
81+
Enter task description: Build Python To-Do App
82+
📌 Task added successfully!
83+
84+
✅ To-Do List Menu
5885
Choose an option: 1
5986

87+
Your Tasks:
88+
1. [] Build Python To-Do App
89+
```
90+
### Example Code Snippet
91+
```
92+
tasks = []
93+
94+
def add_task(task):
95+
tasks.append({"task": task, "completed": False})
6096

61-
Tasks:
62-
1. [] Finish Python project
97+
def show_tasks():
98+
if not tasks:
99+
print("🕳️ No tasks yet!")
100+
for i, t in enumerate(tasks, start=1):
101+
status = "✔" if t["completed"] else "✗"
102+
print(f"{i}. [{status}] {t['task']}")
63103
```
64104
65-
## 🔮 Future Roadmap
105+
## Future Roadmap
106+
| Feature | Status | Description |
107+
| ------------------------ | -------------- | -------------------------------- |
108+
| File storage (JSON) | In Progress | Save and load tasks persistently |
109+
| Task count summary | Done | Shows total & completed tasks |
110+
| Due dates & priorities | Planned | Add deadlines and importance |
111+
| GUI (Tkinter) | Planned | Simple desktop interface |
112+
| Flask/Django web app | Planned | Full-stack upgrade |
113+
114+
115+
116+
### Contributing
66117
67-
💾 Save tasks to a file (JSON/CSV) for persistence.
118+
Contributions are always welcome
119+
- Fork the repo
120+
- Create a new branch:
121+
```
122+
git checkout -b feature/your-feature
123+
```
124+
- Commit & Push your changes
125+
- Open a Pull Request
126+
> Please follow Python’s PEP8 guidelines and include meaningful commit messages.
68127
69-
⏰ Add due dates & priorities to tasks.
128+
## Author
129+
**Mantra Patil**
70130
71-
🎨 Develop a GUI version using Tkinter or PyQt.
131+
💼 LinkedIn: https://www.linkedin.com/in/mantrapatil25
72132
73-
🌐 Extend to a web app with Flask/Django.
133+
✉️ techmantrapatil@gmail.com
74134
75-
## 👨‍💻 Author
135+
<h3 align="center">🌟 Thanks for checking out my Advanced To-Do List project! 🌟</h3> <p align="center"> If you found this useful, please give it a ⭐ on GitHub — it helps a lot! <br><br> <img src="https://img.shields.io/badge/Keep%20Building-Build%20with%20Python-orange?style=for-the-badge&logo=python"> </p>
76136
77-
Mantra Patil
137+
<p align="center"> <img src="https://img.shields.io/badge/Made%20With-Python3-blue?style=for-the-badge&logo=python"> <img src="https://img.shields.io/badge/Platform-Cross%20Platform-brightgreen?style=for-the-badge&logo=windows"> <img src="https://img.shields.io/badge/Status-Active%20Development-orange?style=for-the-badge&logo=githubactions"> <img src="https://img.shields.io/badge/Code%20Style-PEP8-blueviolet?style=for-the-badge&logo=python"> </p>
78138
79-
📚 Engineering Student | Python Developer (Learning) | 🔐 Cybersecurity Enthusiast

0 commit comments

Comments
 (0)