/Night-Duty-Companion

A simple desktop tool to assist RIB Night Duty

Primary LanguagePython

🌜 Night Duty Companion 🌜

pages-build-deployment

NightDutyCompanion is a simple desktop application designed to assist RIB RAs with RIB routine night duty.

Night Duty Companion

🚀 Features

  • Analyze BMS attendance files.
  • Automatically generate messages to be sent to the Boarding Managers.
  • List absent boarders with their contact numbers and room numbers.
  • List boarders on leave with their leave due time.
  • RI styled GUI.

📥 Installation

NightDutyCompanion can be installed using the following methods based on your operating system:

Windows 🪟

  1. Download the executable file from the NightDutyCompanion releases page.

  2. 🚀 Run the downloaded executable file NightDutyCompanion.exe to install NightDutyCompanion. There is no need for additional dependencies or Python installation.

macOS and Linux 🍎🐧

  1. Download the source code from the NightDutyCompanion releases page.

  2. Extract the downloaded zip file.

  3. Open a terminal and navigate to the extracted folder.

  4. Ensure you have Python installed on your system.

  5. Install the required dependencies by running the following command:

pip install -r requirements.txt
  1. Once the dependencies are installed, run NightDutyCompanion by executing the following command in the terminal:
NightDutyCompanion.py

ℹ️ How to Use

Please refer to the User Guide for detailed instructions on how to use NightDutyCompanion. The user guide provides step-by-step explanations and screenshots to help you get started with the application.

📝 Note

My friend and I have tested multiple times, and the data downloading and cleaning process should last less than 1 minute.

NightDutyCompanion is an ongoing project and may have potential bugs and feature limitations. Please don't solely rely on its results at the current stage.

Your feedback and suggestions are greatly appreciated. If you encounter any issues or have ideas for improvement, please feel free to contact me.

🎉 Enjoy using NightDutyCompanion to simplify your night-duty management tasks!