<commit_before># TelegramSchoolBot [![MIT License](https://img.shields.io/github/license/paolobarbolini/TelegramSchoolBot.svg?maxAge=2592000)](LICENSE)
_Interact with your school website with telegram!_

This bot was created to simplify the interaction with my school's website by using telegram.

It allows us to check the school hours of a class, a teacher or a classroom and to optionally receive notifications when new announcements are posted on their website.

## Compatibility
This bot has only been tested on my school's website which is using the [Yoomla CMS](https://www.joomla.org/) with the [JSN Epic](https://www.joomlashine.com/joomla-templates/jsn-epic-joomla-template-details.html) template.
The bot searches for and article on the left side of the screen which contains a link pointing to a page created with [Orario Facile 8](https://www.orariofacile.com/).
The path to the page created with ``Orario Facile`` must start with ``/web_orario`` or ``/weborario``.

It is licensed under the [MIT License](LICENSE), which basically allows you to do whatever you want with it as long as you preserve the copyright and license notices.


## Required dependencies
This bot requires the following dependencies to work:

* make (apt: `build-essential`)
* Python 3 (apt: `python3`)
* PIP (apt: `python3-pip`)
* Virtualenv (apt: `python3-virtualenv`, pip: `virtualenv`)
* Git (apt: `git`)

You can easily install them with the following commands:

```
$ sudo apt install build-essential python3-pip git
$ sudo pip3 install virtualenv
```

## Setup
All of the configurations are stored in the `config.json` file, to create it run:

```
$ make init
```

Edit the `config.json`:

```json
{
  "telegram_token": "BOT-API-KEY",
  "school_website": "URL-OF-YOUR-SCHOOL-WEBSITE",
  "owner": "@YOUR-TELEGRAM-USERNAME",
  "database_url": "THE_DATABASE_URL"<commit_msg>Add correct dependecies in README.md<commit_after># TelegramSchoolBot [![MIT License](https://img.shields.io/github/license/paolobarbolini/TelegramSchoolBot.svg?maxAge=2592000)](LICENSE)
_Interact with your school website with telegram!_

This bot was created to simplify the interaction with my school's website by using telegram.

It allows us to check the school hours of a class, a teacher or a classroom and to optionally receive notifications when new announcements are posted on their website.

## Compatibility
This bot has only been tested on my school's website which is using the [Yoomla CMS](https://www.joomla.org/) with the [JSN Epic](https://www.joomlashine.com/joomla-templates/jsn-epic-joomla-template-details.html) template.
The bot searches for and article on the left side of the screen which contains a link pointing to a page created with [Orario Facile 8](https://www.orariofacile.com/).
The path to the page created with ``Orario Facile`` must start with ``/web_orario`` or ``/weborario``.

It is licensed under the [MIT License](LICENSE), which basically allows you to do whatever you want with it as long as you preserve the copyright and license notices.


## Required dependencies
This bot requires the following dependencies to work:

* Make (apt: `build-essential`)
* Python 3 (apt: `python3`)
* PIP (apt: `python3-pip`)
* Virtualenv (apt: `python-virtualenv` pip: `virtualenv`)
* wkhtmltopdf (apt: `wkhtmltopdf`)
* Xvfb (apt: `xvfb`)

You can easily install them with the following commands:

```
$ sudo apt install build-essential python3 python3-pip python-virtualenv wkhtmltopdf xvfb
```

## Setup
All of the configurations are stored in the `config.json` file, to create it run:

```
$ make init
```

Edit the `config.json`:

```json
{
  "telegram_token": "<PASSWORD>",
  "school_website": "URL-OF-YOUR-SCHOOL-WEBSITE",
  "owner": "@YOUR-TELEGRAM-USERNAME",
  "database_url": "THE_DATABASE_URL"
{'fraction_non_alphanumeric': 0.10598470867387293, 'fraction_numerical': 0.007118375955707883, 'mean_word_length': 5.0126782884310614, 'pattern_counts': {'":': 8, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 8, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '996761', 'n_tokens_mistral': 1204, 'n_tokens_neox': 1117, 'n_words': 449}