Nde-Dilan/Apartement-AMS

A GUI application for managing rooms in an apartement

Apartment Management Application

Welcome to the Apartment Management Application, a desktop GUI application built using tkinter/PyQt6/PySide6. This application is designed to assist in managing an apartment building with a minimum of 20 rooms that are available for rent. It offers various functionalities to help you keep track of tenant information, room status, bills, and tenant statistics.

Table of Contents

• Features
• Installation
• Usage
  • Screenshots
• Contributing
• License

Features

• User-friendly Interface: Provides an intuitive graphical interface for easy interaction.
• Tenant Information: Allows users to input tenant details, including name, apartment number, bills, and current debt, while also tracking the duration of their stay.
• Room Status: Displays room status, including occupied, vacant, and rooms needing repair.
• Bill Reminders: Sends email reminders to tenants for rent, water, and light bills.
• Payment Statistics: Stores and provides statistics on past payments, allowing users to track payment history.
• Tenant Viability: Utilizes statistics to determine if a tenant is eligible for a contract extension based on timely bill payments for at least 6 months.
• Tenant Graphs: Offers graphical representations of tenant statistics, enabling better visualization of data.

Installation

To get started with the Apartment Management Application, follow these steps:

1. Clone this repository to your local machine using your preferred method (HTTPS, SSH, or GitHub CLI):

   git clone https://github.com/Nde-Dilan/Apartement-AMS.git
   

2. Install the required dependencies, including matplotlib, numpy, sqlite3, and scipy:

   pip install matplotlib numpy sqlite3 scipy PyQt5
   

3. Run the application and if there's an error please open an issue.

Usage

To use the Apartment Management Application, follow these instructions:

1. Launch the application.

2. Explore the following functionalities:

   • Check room status to see which rooms are occupied, vacant, or in need of repair.
   • Send bill reminders to tenants for rent, water, and light bills.
   • View and analyze payment statistics to monitor tenant payment history.
   • Determine tenant viability for contract extensions based on timely bill payments.
   • Visualize tenant statistics using graphical representations.

Screenshots

Contributing

Contributions to this project are welcome! If you have any ideas, bug fixes, or improvements to suggest, please feel free to submit a pull request.

License

This project is licensed under the MIT License.

---