Water-Chan

---

Introduction:

Water-Chan is a Tkinter-based Python desktop application that reminds you to drink water in a random time between 7 PM - 9 PM locally.

Overview:

Disclaimer: This is a joke application I made for a friend and I do not recommend it for personal use, professional use & especially medical use. Limitation and warranty is limited.

Packaging:

To build the application directly from the source code, follow these instructions:

-Clone the repository by running:

git clone https://github.com/AzuritilDev/Water-Chan.git

-Change your directory into the cloned repository's directory:

cd water-chan

-Install pyinstaller (skip if you have already done that):

pip install pyinstaller

-Lastly, run this command:

(Windows)

pyinstaller --onefile --noconsole --name "Water-Chan" --icon "assets/waterchanicon_ico.ico" --paths=. --add-data "assets;assets" --add-data "pyproject;." src/main.py

(Linux/MacOS)

pyinstaller --onefile --noconsole --name "Water-Chan" --icon "assets/waterchanicon_ico.ico" --paths=. --add-data "assets:assets" --add-data "pyproject:." src/main.py

-Note: This app wasn't built for Linux nor MacOS and it may not run at all yet alone run properly in these operating systems.

Running the App

To run the app without turning it into an .exe file, do the following:

-Clone the repository by running:

git clone https://github.com/AzuritilDev/Water-Chan.git

-Change your directory into the cloned repository's directory:

cd water-chan

-Install dependencies: pip

pip install -r requirements.txt

uv

uv sync

-Run the program:

1. Without venv (virtual environment)

python

python -m src.main

or

python3 -m src.main

python with uv

uv run python -m src.main

2. With venv (virtual environment)

python

python -m venv .venv

python with uv

uv venv

Running the virtual environment (Windows)

.venv\Scripts\activate.bat

Running the virtual environment (Linux/MacOS)

source .venv/bin/activate

Contribution:

Please see our CONTRIBUTING markdown file.

Code of Conduct:

Please see our CODE OF CONDUCT markdown file.

Authors:

@AzuritilDev, The Maintainer (Contact: azuriteluadev@proton.me)

License:

Distributed under GNU General Public License v3.0