File | Date | Author | Commit |
---|---|---|---|
demo | 2025-07-11 |
![]() |
[9ddc1a] build success |
images | 2025-07-11 |
![]() |
[9ddc1a] build success |
sounds | 2025-07-10 |
![]() |
[cd65d7] Initial local commit |
.gitignore | 2025-07-10 |
![]() |
[f7e2d5] Initial commit |
BUILD_GUIDE.md | 2025-07-10 |
![]() |
[96aa30] build succeed |
CHANGELOG.md | 2025-07-10 |
![]() |
[96aa30] build succeed |
LICENSE | 2025-07-10 |
![]() |
[f7e2d5] Initial commit |
README.md | 2025-07-11 |
![]() |
[9ddc1a] build success |
README_BUILD.md | 2025-07-10 |
![]() |
[96aa30] build succeed |
build_deb.sh | 2025-07-10 |
![]() |
[96aa30] build succeed |
glass_checkbox.py | 2025-07-10 |
![]() |
[96aa30] build succeed |
main.py | 2025-07-11 |
![]() |
[9ddc1a] build success |
requirements.txt | 2025-07-10 |
![]() |
[96aa30] build succeed |
style.qss | 2025-07-11 |
![]() |
[9ddc1a] build success |
version.py | 2025-07-10 |
![]() |
[96aa30] build succeed |
TimeRing is a versatile and user-friendly timer application designed to help you manage your time effectively. Whether you're working, studying, or cooking, TimeRing provides a clean and intuitive interface to run multiple timers at once. Built with PyQt5, it's designed with a focus on Linux but is architected to be cross-platform.
For an easy installation on Debian-based systems (like Ubuntu), a .deb
package will be available in the GitHub Releases section and on SourceForge. This is the recommended method for most users.
For other systems or for development, you can install from source.
Ensure Python 3.11+ and pip
are installed on your system.
# Ubuntu/Debian
sudo apt update
sudo apt install python3 python3-pip
# Fedora/RHEL
sudo dnf install python3 python3-pip
# Arch Linux
sudo pacman -S python python-pip
Clone the repository:
bash
git clone https://github.com/Lusan-sapkota/TimeRing.git
cd TimeRing
Create and activate a virtual environment:
bash
python3 -m venv venv
source venv/bin/activate
On Windows, you would use venv\Scripts\activate
.
Install dependencies:
Inside the activated virtual environment, install the required Python packages.
bash
pip install -r requirements.txt
Run the application:
bash
python3 main.py
Each active timer card displays its name, remaining time, and status. The action buttons change based on the timer's state:
The large active timer display shows the currently selected running timer with enhanced controls:
Click each menu icon to access:
This application is developed and tested primarily on Linux. Many features, especially those relying on system libraries like desktop notifications (libnotify
) and audio (VLC
), are tailored for a Linux environment.
While it may run on Windows or macOS with Python and PyQt5 installed, some functionalities might not work as expected out-of-the-box. The notification system, in particular, would require platform-specific implementation to work on other operating systems.
TimeRing stores its configuration files in ~/.config/TimeRing/
:
settings.json
: Application preferences.timers.json
: The state of all active timers.You can customize the application's appearance by editing style.qss
. This file uses standard Qt CSS syntax. For example, to change the primary button color:
QPushButton#startButton {
background-color: #4CAF50; /* A nice green */
}
Contributions are welcome! If you'd like to improve TimeRing, please follow these steps:
main
branch.You can find the repository here: https://github.com/Lusan-sapkota/TimeRing
This project is licensed under the MIT License. See the LICENSE file for details.
Lusan Sapkota