TimeTrack

TimeTrack is a simple yet powerful time tracking application designed for managing work hours, leaves, and holidays. Built with Flask and compatible with PostgreSQL or SQLite, it provides a user-friendly interface for tracking your time and analyzing your work patterns.

🌟 Features

• 📅 Flexible Time Entry - Record multiple clock in/out entries per day
• 🏖️ Absence Management - Track leaves, holidays and other time off
• 📊 Time Analytics - View daily, weekly and monthly work summaries
• 📈 Automatic Calculations - Track work hour balances and overtime
• 🇦🇷 Argentina Holidays Integration - Automatic holiday tracking for Argentina
• 📱 Responsive Design - Works on desktop and mobile devices
• 🔌 Flexible Database Support - Works with SQLite or PostgreSQL
• 🧪 Well-tested Code - Comprehensive test suite ensures reliability

🚀 Quick Start

Prerequisites

• Python 3.9+
• pip (Python package installer)
• PostgreSQL (optional, SQLite works out of the box)

Installation

1. Clone the repository:

git clone https://github.com/PPeitsch/TimeTrack.git
cd TimeTrack

2. Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate  # Linux/Mac
venv\Scripts\activate  # Windows

3. Install dependencies:

pip install -r requirements.txt

4. Set up environment variables:

cp .env.example .env
# Edit .env with your preferred settings

5. Initialize the database:

python init_db.py

6. Run the application:

flask run

7. Access the application at http://localhost:5000

📖 Usage

Manual Time Entry

1. Navigate to "Manual Entry" to record your work hours
2. Select a date and whether it's a regular work day or absence
3. For work days, enter your clock-in and clock-out times
4. You can add multiple time entries per day (e.g., for lunch breaks)

Time Summary

View a monthly summary of your work hours, including:

• Required hours based on working days
• Actual hours worked
• Balance (overtime or deficit)
• Daily breakdown with detailed information

Time Logs

Access a chronological log of all your time entries, including:

• Regular work days with specific times
• Absences and holidays
• Daily totals

📁 Project Structure

TimeTrack/
├── app/
│   ├── config/        # Configuration settings
│   ├── db/            # Database management
│   ├── models/        # Data models
│   ├── routes/        # Route handlers
│   ├── static/        # Static assets (JS, CSS)
│   ├── templates/     # HTML templates
│   └── utils/         # Utility functions
├── scripts/           # Helper scripts
├── tests/             # Test suite
├── .env               # Environment configuration
├── .env.example       # Example environment configuration
├── app.py             # Application entry point
├── init_db.py         # Database initialization script
└── requirements.txt   # Python dependencies

🧪 Development

Setting Up Development Environment

1. Install development dependencies:

pip install -r requirements-dev.txt

2. Set up pre-commit hooks:

pre-commit install

Running Tests

pytest tests/

Code Formatting

We use Black and isort for code formatting:

# Format code with Black
python -m black .

# Sort imports with isort
python -m isort --profile black .

# Run both with our helper script
python scripts/run-formatters.ps1  # Windows
./scripts/run-formatters.sh  # Linux/Mac

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an Issue.

Please read our Contributing Guidelines and follow our Code of Conduct.

📄 License

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

✨ Acknowledgements

• Flask - The web framework used
• SQLAlchemy - ORM for database operations
• Bootstrap - Frontend framework