Awesome

RastreioBot

About
Setup
Run
Contribute
Contact

About

This is a Telegram Bot that tracks packages from the Brazilian Mail Service. It runs on Python 3 and uses MongoDB.

Try it!

Setup

We use Poetry to manage our dependencies. Check out its Poetry guide to install it on your machine.

To install the required packages, use the command below. It will install the runtime and also the development dependencies (e.g. Pytest).

$ poetry install

Create a file bot.conf following bot.conf_sample.

TOKEN Bot token generated by BotFather

int_check Minimum interval between checks for the same package (3600 means 1 hour)

*_log Log files

patreon List of people that donate to the bot

Banned List of banned users

usuario User provived by Correios

senha Password provided by Correios

token Token provided by Correios

key Key provided by TrackingMore

url Sentry URL

MongoDB

RaspberryPi

https://github.com/GabrielRF/Docker-MongoDB-RPi

Mac

brew install mongodb-community
brew services start mongodb-community

SQLite

touch data_base.db

create db structure

CREATE TABLE assinantes (
        id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
        chatid TEXT,
        picpayid TEXT);

Commands available

$ poetry run rastreio --help
Usage: rastreio [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  packages:clean                  Clean old and duplicated packages
  packages:update                 Update active packages
  packages:delete <package-code>  Delete a package
  bot:run [--maintenance]         Set bot to maintenance mode

Running tests

The tests are running on pytest, so, in order to run them, just do

poetry run pytest

Contribute

Pull requests and issues are welcome!

Contact

Site