How callisto-aurelia/hotel-management works
Project Type and Purpose
• This is a console-based, full-stack (single-process) application written in Python with a MySQL backend.
• It provides hotel operations functionality: room management, customer management, reservations, check-in/out, and billing.
File Structure
• main.py: entry point, orchestrates menu and dispatches user choices.
• admin.py, employee.py, user.py: modules handling role-specific workflows.
• funcs.py: shared business logic and utility functions.
• tables.py: schema definition and table-creation scripts.
• sql_insertion.py: initial data seeding into MySQL.
• README.md: documents features, tech stack, and contributors.
README for Technical Insights
• Python + mysql-connector-python for DB connectivity.
• texttable for CLI table formatting.
• Standard modules for I/O and data processing.
Main Components
a. Actors (External Users)
• Admin user
• Employee user
• Guest/General user
b. Presentation Layer
• CLI Menu (main.py)
• texttable module for output formatting
c. Application Layer (Business Logic)
• Admin workflows (admin.py)
• Employee workflows (employee.py)
• Customer/Reservation workflows (user.py)
• Shared utilities (funcs.py)
d. Data Layer
• Data-access wrappers (mysql-connector-python calls inside each module)
• Schema setup (tables.py)
• Data seeding (sql_insertion.py)
e. Persistence
• MySQL Database (Rooms, Customers, Reservations, Payments, Employees, Admins)
Interactions and Data-flow
1. Actor selects option in CLI → main.py
2. main.py routes to appropriate module (admin.py / employee.py / user.py)
3. Module invokes funcs.py for shared validations or computations
4. Module issues SQL queries via mysql-connector-python to MySQL
5. MySQL returns result sets → python module processes results
6. Results rendered back to user via texttable in CLI
Architectural Patterns and Design Principles
• Layered architecture: Presentation → Business Logic → Data Access → Persistence
• Single responsibility: each module handles one actor’s use-cases
• Shared utility library (funcs.py) to avoid code duplication
• Modular DB schema initialization (tables.py) and seeding (sql_insertion.py)
Relevant Technologies & Libraries
• Python 3.x
• mysql-connector-python
• texttable
• MySQL Server