Quick start

This documentation presents an extensive description of all the python functions defined in this project. Other resources include:

• The repository README.md, concerning the installation and run of the project on a local machine.
• Links to the official documentations of all the API used by this project, reported in the file info/api_reference.txt.
• The command cheatsheet, located in info/cheatsheet.md. It also summarizes the database structure.
• The project report, report/alex_pegoraro_report.pdf, with a full description of the system architecture.

Project structure

The modules employed by this project and their locations are listed in the Files page of this documentation. Accessing them will allow you to inspect all the functions they declare. Such modules are imported in three main Python scripts:

• create_db.py: This script is used to create the SQLite database from scratch.
• edit_db.py: With this file you can modify directly the database without the need to contact the Telegram API.
• bot_main.py: Main file that runs the Telegram Bot and exposes it through the internet.

Have a look at README.md to know how to properly use them.

Maintainer

Alex Pegoraro