Cygnus 🦢

A powerful, Yeolpumta-inspired study timer and productivity tracking application with rich analytics, built in Python and PyQt6.

📥 Download

The easiest way to use Cygnus on Windows is to download the standalone executable. You don't need to install Python or any dependencies.

🚀 Download the Latest Windows Executable (Cygnus.exe)

Alternatively, visit the Releases page to see all available versions.

(Note: If you run into formatting or execution issues on Windows, be sure to "Run as Administrator" or add an exception in your antivirus, as locally built .exe files sometimes trigger false positives.)

✨ Features

• ⏱️ Study Timer & Session Tracking: Focus deeply with a Yeolpumta-inspired interface. Also supports the manual addition of past study sessions.
• 📝 To-Do List Management: Organize your tasks with an intuitive to-do list, complete with a comprehensive Weekly View.
• 📊 Rich Analytics & Heatmap: Track your progress over time through detailed study heatmaps and analytics.
• 📸 Daily Statistics Snapshot: Generate, view, and share/download a beautiful daily snapshot of your study statistics.
• 👤 User Profile System: Customize your experience with a personal user profile, including support for custom square profile pictures.
• 💡 Motivational Quotes: Stay inspired with a curated collection of physics, math, and study-related motivational quotes displayed on the home page.
• 🛡️ Safe & Reliable: Confirmation dialogs for destructive actions prevent accidental data loss.
• 📞 Contact Us: Easily reach the developer via the integrated sidebar section for Reddit, Discord, and GitHub links.

🛠️ Technology Stack

• Python (>= 3.13)
• PyQt6 - Modern GUI framework.
• SQLModel - Powerful database interaction combining SQL with Pydantic type hints.
• PyInstaller - For packaging the app into a standalone Windows .exe.
• uv - For ultra-fast Python project and package management.

🚀 Running Locally & Development

Prerequisites

Ensure you have Python 3.13+ installed. We recommend using uv for managing dependencies.

Installation

1. Clone the repository:

   git clone https://github.com/MohammadSameer-Dev/Cygnus.git
   cd Cygnus

2. Install dependencies: Using uv (recommended):

   uv sync

   Or using pip:

   pip install .

   (If you are installing for development, you can use uv sync --group dev)

Running the App

To start Cygnus from the source, run:

uv run src/app/main.py

Packaging the Application for Windows

If you want to build the .exe yourself:

uv run build.py

Note: This relies on PyInstaller and the provided Cygnus.spec file. The resulting application will be placed in the dist folder.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check out the issues page if you want to contribute.

📝 License

Distributed under the MIT License. See LICENSE for more information.