Contributing

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ayushpai/AI-Math-Notes/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

​

Getting Started

​

Prerequisites

• Python 3.x
• OpenAI API key
• Basic understanding of Tkinter and PIL

​

Setup Development Environment

1. Clone the repository
2. Install dependencies:
   pip install -r requirements.txt
   
3. Set up your OpenAI API key as an environment variable:
   export OPENAI_API_KEY="your-api-key-here"
   
4. Run the application:
   python main.py
   

​

Project Structure

.
├── main.py              # Core DrawingApp class and application logic
├── requirements.txt     # Python dependencies (pillow, openai)
├── README.md           # User-facing documentation
└── LICENSE             # MIT License

​

Future Improvements

​

Auto-detect Equals Sign

last_action = self.actions[-1]
last_coords = last_action[-1][-1]

equals_x = last_coords[2]
equals_y = last_coords[3]

• Detect equals signs anywhere on the canvas
• Identify which equations are unanswered (no value on the right side)
• Position answers correctly regardless of drawing order

• Use OCR/symbol detection on the PIL Image
• Train a custom model to recognize mathematical symbols
• Integrate OpenCV for contour detection and symbol classification
• Modify draw_answer() to accept detected equals sign coordinates

​

Other Contribution Ideas

1. Error Handling: Add try-except blocks around API calls (main.py:95-110)
2. Loading Indicators: Show visual feedback during API processing
3. Multiple Equations: Support solving multiple equations in one session
4. Export Functionality: Save canvas as image file
5. Configuration: Make canvas size, colors, and fonts customizable
6. Response Validation: Verify API responses are valid numbers
7. Offline Mode: Cache common calculations
8. Handwriting Recognition: Improve accuracy with preprocessing

​

Contribution Guidelines

​

Code Style

• Follow PEP 8 Python style guidelines
• Maintain the existing class structure
• Add comments for complex logic
• Keep methods focused and single-purpose

​

Testing Your Changes

1. Test basic drawing functionality
2. Verify undo/clear operations work correctly
3. Test calculation with various equations:
   • Simple arithmetic: 5 + 3 =
   • Multiple operations: 10 * 2 + 5 =
   • Edge cases: 0 / 0 =
4. Ensure both keyboard shortcuts work (Cmd/Ctrl+Z, Enter/Return)

​

Submitting Changes

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test thoroughly
5. Submit a pull request with:
   • Clear description of changes
   • Why the change is needed
   • Any testing performed

​

Key Areas for Contribution

​

1. Drawing Engine (main.py:45-60)

• Add brush size controls
• Support different colors
• Implement eraser functionality
• Add shape drawing tools

​

2. API Integration (main.py:87-113)

• Add error handling and retries
• Implement response validation
• Support alternative models
• Add rate limiting

​

3. User Interface

• Add menu bar with File/Edit/Help
• Create settings dialog
• Improve button layout
• Add status bar for feedback

​

4. Action Management (main.py:68-85)

• Implement redo functionality
• Add action history limit
• Support selective undo (undo specific strokes)

​

License

MIT License

Copyright (c) 2024 Ayush Pai

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

​

Getting Help

​

Recognition