WouterVanGoey / tick_tock_tone

TickTockTone

TickTockTone is a chime application that rings at user-defined times, inspired by traditional cuckoo clocks but with a modern twist. It allows users to select intervals for chimes and even choose the chime sound from available .mp3 files in the application directory.

Features

• Customizable Chime Intervals: Set the application to chime at specific intervals, such as every hour, every half hour, or even every 10 minutes.
• Chime Sound Selection: Choose your preferred chime sound from the .mp3 files available in the application directory.
• Simple and Intuitive UI: Powered by CustomTkinter, the application offers a modern and easy-to-use interface.

Installation

TickTockTone requires Python 3.12 or later. It's recommended to use a virtual environment to avoid conflicts with other packages.

1. Clone the Repository

   git clone https://github.com/yourusername/TickTockTone.git
   cd TickTockTone
   

2. Install Dependencies

   The project uses Poetry as its dependency manager. Install Poetry if you haven't already. Then, install the project dependencies:

   poetry install
   

3. Run the Application

   Once the dependencies are installed, you can run TickTockTone using Poetry:

   poetry run python ticktocktone.py
   

Usage

Upon launching TickTockTone, you'll be greeted with the main window. Here's how to get started:

• Set the Chime Interval: Use the dropdown menu to select how frequently you want the chime to ring.
• Select a Chime Sound: Choose your preferred chime sound from another dropdown menu populated with .mp3 files found in the application directory.
• Start the Chiming: Click the "Start" button to activate the chiming. The button will turn into a "Stop" button, allowing you to halt the chiming at any time.
• Test Chime Sound: Click the title frame "TickTockTone" to play the currently selected chime sound immediately.

Contributing

Contributions are welcome! If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

License

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

Contact

Wouter Van Goey - [e-mail]

Project Link: https://github.com/yourusername/TickTockTone