Kronos

Kronos is a simple Python timepiece utility tool with a nice GUI.
This application uses CustomTkinter and CTkMessagebox.
The available binaries were compiled with Nuitka.

Table of Contents

• Preview
• Current Features
• Requirements
• How to Use
• Using the Source Code
• How to Contribute

Preview

Current Features

• Intuitive and sleek interface
• Error handling with message boxes
• Stopwatch functionality
• Timer functionality

Requirements

If you plan on using the source code version, you'll need the latest Python version. 🐍
Otherwise, using the binaries does not require anything.

How to Use

1. Download the latest release of this project;
2. Open the .exe (Or, if you're on Linux, give the .AppImage executable permissions with chmod +x and open it);
3. To use the stopwatch, simply click on "Start" to start counting;
4. For the timer, click on the "Timer" button to switch to its interface, set the countdown timer and click "Start".

Using the Source Code

1. Clone the repository:

   git clone https://github.com/Guilherme-A-Garcia/Kronos.git
   cd Kronos

2. Create and activate a virtual environment (recommended):

   python3 -m venv venv
   source venv/bin/activate

3. Install the required packages using the requirements.txt file:

   pip install -r requirements.txt

4. Run main.py within the project's directory:

   python main.py

How to Contribute

✨ Contributions are always welcome! ✨

• Report Bugs: Open an issue with detailed steps to reproduce.
• Suggest Features: Open an issue to discuss your idea.
• Contribute Directly to the Code:
  I. Fork the repository;
  II. Create a new branch;
  III. Make your changes and commit;
  IV. Push to the branch;
  V. Open a Pull Request;
  VI. Kindly wait for approval. ;)
  

Thank you for reading!