📉 Mistake Tracker

🎯 Track your learning mistakes. Identify weak points. Improve efficiently.

Features • Installation • Usage • Contributing

---

✨ Features

📝 Log Mistakes Record subject, error description, and solution with automatic timestamps. 📊 Smart Analytics View error breakdown and percentage by subject to identify weak points. 🔍 Search & Filter Find mistakes quickly with keyword search across all entries.

✏️ Edit & Delete Modify or remove entries when needed with confirmation prompts. 💾 Auto-Backup Data is saved instantly with automatic backup rotation (20 versions). 📄 Pagination Browse through large datasets with paginated view (10 items/page).

---

🚀 Installation

Option 1: Quick Start (Recommended)

# Step 1: Clone the repository
git clone https://github.com/minx-nie/Mistake-Tracker.git
cd Mistake-Tracker

# Step 2: Install the package
pip install -e .

# Step 3: Run the program
python -m mistake_tracker

⚠️ Important: You must run pip install -e . before using python -m mistake_tracker, otherwise you'll get "No module named mistake_tracker" error.

---

Option 2: Run Without Installing

If you prefer not to install, run the standalone script directly:

git clone https://github.com/minx-nie/Mistake-Tracker.git
cd Mistake-Tracker

# Run standalone script (no install needed)
python Mistake_Tracker.py

---

Option 3: Development Setup

git clone https://github.com/minx-nie/Mistake-Tracker.git
cd Mistake-Tracker

# Install with development dependencies
pip install -e ".[dev]"

# Setup pre-commit hooks
pre-commit install

# Run tests
pytest tests/ -v

---

📖 Usage

Main Menu

When you run the program, you'll see this menu:

╔══════════════════════════════════════╗
║       📉 MISTAKE TRACKER             ║
╠══════════════════════════════════════╣
║  [1] ➕ Add New Mistake              ║
║  [2] 📋 View Mistakes                ║
║  [3] ✏️  Edit/Delete                  ║
║  [4] 🚪 Exit                         ║
╚══════════════════════════════════════╝

Choose (1-4):

---

1️⃣ Add New Mistake

Select 1 → Enter the details:

━━━ ➕ Add New Mistake ━━━
Subject: math
Mistake: Wrong formula for area calculation
Fix: S = pi * r^2, not 2*pi*r

✅ Mistake added successfully!

---

2️⃣ View Mistakes & Statistics

Select 2 → See statistics and list:

━━━ 📋 View Mistakes ━━━
🔍 Filter by keyword (Enter to skip):

📊 Statistics (Total: 15)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Subject              │ Count │  Rate
─────────────────────┼───────┼───────
Math                 │    10 │ 66.7%
English              │     3 │ 20.0%
Coding               │     2 │ 13.3%

📝 All Mistakes
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
1. [Math] Wrong formula → S = pi*r^2 (2024-12-23)
2. [Math] Sign error → Check steps again (2024-12-22)
...

💡 Tip: Enter a keyword to filter mistakes by subject, description, or fix.

---

3️⃣ Edit or Delete

Select 3 → Choose entry number → e to edit or d to delete:

━━━ ✏️ Edit/Delete ━━━
1. [Math] Wrong formula
2. [English] Grammar mistake

Choose number (0 = cancel): 1
(e)dit / (d)elete: e

💡 Leave blank to keep current value.
Subject [math]:
Mistake [Wrong formula]: Wrong volume formula
Fix [S = pi*r^2]: V = 4/3 * pi * r^3

✅ Updated.

---

4️⃣ Exit

Select 4 to safely exit the program. Your data is automatically saved!

---

🛠️ Tech Stack

Tool	Purpose
	Core language (3.9+)
	Testing framework
	Linting & formatting
	Type checking
	CI/CD

---

📂 Project Structure

Mistake-Tracker/
├── 📁 src/mistake_tracker/
│   ├── __init__.py      # Package init
│   ├── __main__.py      # Entry point
│   ├── cli.py           # CLI interface
│   └── data.py          # Data management
├── 📁 tests/
│   └── test_tracker.py  # Unit tests
├── 📁 .github/workflows/
│   └── ci.yml           # GitHub Actions CI
├── Mistake_Tracker.py   # Standalone script (legacy)
├── pyproject.toml       # Project config
├── ruff.toml            # Linter config
└── README.md

---

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing)
5. Open a Pull Request

---

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with ❤️ by minx-nie