hazbin-hotel 1.0.0

No project description provided

Seminar of Software Engineer

Basic project that implement tests with Pytest and poetry dependence manager into a hotel reservation system.

Team

• Pedro Luis
• Arthur Bueno
• Pedro Augusto
• Marcos Henrique

Requirements

• Chrome extension to view mermaid diagrams: Mermaid Previewer
• Python 3.12

Architecture

classDiagram
    class Room {
        - int number
        - string type
        - float price
        - float multiplier_factor_price
        - list~Schedule~ schedules
        + get_number() int
        + get_type() string
        + get_room_price() float
        + update_schedule() bool
        + update_price(new_price: float) bool
        + add_schedule(schedule: Schedule) bool
        + is_period_available(period: Period) bool
    }

    class Schedule {
        - int id
        - string client_name
        - Room room
        - Period period
        + get_client_name() string
        + get_room() Room
    }

    class Period {
        - Date start
        - Date end
        + change_start() bool
        + change_end() bool
    }

    Room "1" <-- "*" Schedule : "associates with"
    Schedule "*" --> "1" Period

Code Quality

Linter

The project uses flake8 as linter. To run the linter in all code, execute the following command:

flake8 .

If the linter find a problem, it will show a message with the error.

./src/Schedule.py:13:3: E303 too many blank lines (2)
./src/Schedule.py:20:1: W391 blank line at end of file

Fixing the error manually and when finish, flake8 will not show any message.

Formatter

The project uses black as formatter. To run the formatter in all code, execute the following command:

black .

Sorting Imports

The project uses isort as sorting imports. To run the sorting imports in all code, execute the following command:

isort .

Resume

• Black: A code formatter that applies consistent style across your code automatically.
• isort: Organizes and sorts imports to keep them clean and PEP 8-compliant.
• Flake8: A linter that checks for syntax errors, potential bugs, and style violations.

Documentation

• GitHub Pages: https://pedroluisdionisiofraga.github.io/poetry-and-pytest-usage/

Release

• PyPi: https://pypi.org/project/hazbin-hotel/