The official implementation of this project can be found at @USPhonebook_bot.

To set up a development environment, you will need Pipenv, and a copy of python 3.7.

$ pipenv install --dev

Then, ping the @botfather on telegram and obtain a bot token. Add it to your .env file.

$ cp .env.example .env
$ vim .env

check

Runs the Mypy static type checker.

migrate

Creates a database file, including the necessary tables.

reset

Deletes the current database file, then runs migrate (above).

start

Starts the bot.

test

Runs the pytest tests.

For example, pipenv run test would run the script test, as described above. The database file is specified by the .env file. The default name is phonebook.db.