Um bot do Telegram para ajudar estudantes da UFFS no dia a dia.
Até o momento, as seguintes funções estão implementadas:
✔️ Visualização do cardápio do restaurante universitário;
✔️ Envio automático do cardápio do RU diariamente/semanalmente;
✔️ Visualização do cardápio de lanches da cantina;
✔️ Visualização dos horários de ônibus;
✔️ Visualização dos próximos eventos na UFFS;
✔️ Download em PDF do calendário acadêmico;
✔️ Visualização de datas importantes (rematrícula, ajuste, férias, etc).
Inicie uma nova conversa no Telegram e procure por @UFFS_Bot.
O bot é hospedado no Heroku e utiliza a biblioteca python-telegram-bot para enviar/receber requisições.
Antes de tudo, você precisa criar um bot em seu telegram, consultando o @BotFather.
Depois, crie um arquivo nomeado .env
dentro da pasta src/conf
e configure a API key do seu recém criado bot:
telegramToken=SUA_CHAVE_AQUI
Se você deseja rodar as funcionalidades do cardápio, também é necessário as chaves htciId
e htciKey
, que podem ser criadas na API hcti.io.
Também é necessário instalar o postgres e configurá-lo.
sudo apt-get install postgresql
Após a instalação deverá criar um usuário e um banco de dados.
sudo -u postgres psql
CREATE DATABASE <nomedodatabase>;
CREATE ROLE <nomedousuario> WITH PASSWORD '<senha>' SUPERUSER LOGIN;
Após criar um banco e um usuário deverá setar o 'DATABASE_URL' no arquivo '.env' para poder acessar o banco. A URL deve ser parecida com a seguinte.
DATABASE_URL=postgresql://<nomedousuario>:<senha>@localhost/<nomedodatabase>
Para executar localmente, você deve executar o seguinte comando na pasta raíz do repositório:
python src/uffsBot.py
É necessário o Python 3 e as dependências podem ser instaladas com o comando:
pip install -r requirements.txt
Por favor sinta-se a vontade para contribuir. Antes de fazer um pull request, crie um bot no Telegram e teste suas alterações.