Skip to content

rougeth/i17obot

Repository files navigation

🐍💱 i17obot

Tests Workflow

@i17obot - A Telegram bot created to help the translation of the Python documentation to Brazilian Portuguese, expanded to multiple languages and projects.

Installing

Dependencies

$ pipenv install

If you don't have pipenv available, you can install it via pip.

Database

Make sure you have a MongoDB instance running and setup the DATABASE key at .env file with its URL access. If you have Docker available, the following command should be enough docker run -p 27017:27017 -d mongo.

Configuration

Create a new .env file based on local.env and populate it with the listed variables:

$ cp local.env .env

To run i17obot, you will also need:

  • Telegram API Token: talk to @BotFather to create a bot and to retrieve its token.
  • Transifex API Token: Go to your account settings at Transifex website, create a new token in the API token section.

Running

To run the bot

$ pipenv run python -m i17obot run

To run the reminder task

$ pipenv run python -m i17obot reminder

FAQ

Why the project isn't in Portuguese?

Because we want to make it accessible to people translating the Python docs to other languages.

But why i17o?

Internacionalização
I ---- 17 letters --- O

"Internacionalização" is the Portuguese translation of "Internationalization", which is frequently abbreviated to the numeronyms i18n.

[...] means of adapting computer software to different languages, regional peculiarities and technical requirements of a target locale.

About

🐍💱 Telegram bot to translate Python docs to pt_BR

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published