Skip to content

Latest commit

 

History

History
77 lines (53 loc) · 2.84 KB

README.md

File metadata and controls

77 lines (53 loc) · 2.84 KB

Pylabar : An Automated Notification and Feedback System

py-labar is a fast and convenient way to get the opinion of people on various topics, incluging rating, implemented in Python.

Pylabar Banner

Use Cases

  • Employees can quickly get opinions or feedback from colleagues on a specific topic.

  • Eliminates the need for manual notification by automatically sending topic to selected recipients or groups.

  • Suitable for different types of topics, such as event planning, sprint ratings, or employee of the month selection.

How to run the application?

In this section you will find an overview on how to execute and configure the project.

Requirements

Make sure you have the following components installed before running the application:

Dependencies

Dependencies are automatically managed by Poetry

To turn on the environment and install dependencies run

poetry shell
poetry install

in same folder where your .toml file is located. Poetry will take care of:

  • Installing the required Python interpreter
  • Installing all the libraries and modules
  • Creating the virtual environment for you

Refer to this link to configure Poetry on PyCharm

Running on local

You can launch the web application with the command :

python main.py

Technologies used to develop Pylabar

  • Python as the main programming language
  • FastAPI as the main framework
  • Starlette prefered for certain web services responses
  • Pydantic for frontend data validation
  • HTMX for handling dynamic interactions (instead of raw JavaScript)
  • Jinja templates with HTML and CSS for the frontend
  • SQLite for the local database
  • unittest and pytest for testing
  • mypy for static type cheking

Documentation

To read the API docs, open the following page:

http:localhost/docs for classic OpenAPI docs

Aditional information can be found in py-labar's repo Wiki:

PyLabar Wiki

Credits