Skip to content

Latest commit

 

History

History
131 lines (95 loc) · 3.75 KB

README.md

File metadata and controls

131 lines (95 loc) · 3.75 KB
Raw

bilbot

Un bot del DCC para Telegram.
Un bot de Telegram para el DCC.
Para el DCC, de Telegram, un bot.
Porque todo eso... es bilbot.

(Ya, no tenía idea qué escribir acá.)

Receta

Ingredientes

🐍 Python será nuestra herramienta de trabajo.
⚠️ Para evitar posibles fallas de compatibilidad, se deberá usar una versión de Python superior a 3.3.

Archivos

Los archivos del repositorio están resumidos en la siguiente tabla.

Nombre Descripción
bilbot (véase la tabla de abajo)
.gitignore Archivos ignorados por Git.
.pylintrc Config-file de pylint.
LICENSE Documento con el Mozilla Public License.
README.md self
requirements.txt Archivo de dependencias para pip.
tox.ini Config-file de flake8.

En bilbot/

Nombre Descripción
bilbot.cfg Config-file de bilbot.
bilbot.py Módulo esencial de Bilbot.
changelog.py Módulo con el changelog.
commands.py Módulo con todos los comandos de bilbot.
messages.py Módulo con los mensajes para los usuarios.
settings.py Módulo con los ajustes de bilbot.

Librerías de Python

Las librerías utilizadas están resumidas en la siguiente tabla.

Nombre Descripción Versión
python-telegram-bot Un wrapper del API de Telegram Bot. 5.3.0
flake8 Un linter para hacer respetar el PEP8. 2.6.2
pylint Un linter que impone buenas prácticas. 1.6.4

Estas librerías también aparecen en requirements.txt. Luego, se deberá usar este archivo para instalarlas con pip.
Esto nos permitirá trabajar con las mismas versiones, consiguiendo instalaciones replicables, sin hacer esfuerzo.
Bueno, un poco: debemos escribir...

$ pip install -r requirements.txt

En efecto, esto es... as easy as py. 😀

Preparación

Para utilizar a Bilbot localmente, debes seguir los siguientes pasos.

  1. 🐑 Clona el repositorio. Luego, accede.

    $ git clone https://github.com/nkawasg/bilbot.git
$ cd bilbot

  2. 🔧 Genera un entorno virtual de Python v3.X con virtualenv. En este caso, se llamará venv.
    No olvides que X debe ser: {3, 4, 5, 6}.

    $ virtualenv --python=python3.X venv

  3. ▶️ Activa el entorno virtual.

    $ source venv/bin/activate

  4. ✅ Instala las dependencias con pip.

    $ pip install -r requirements.txt

  5. 🔧 Configura el archivo bilbot/bilbot.cfg con el token de tu bot.

  6. 🐍 Ejecuta el script.

    $ python3 bilbot/bilbot.py

  7. 🎉 Voilà!
    Ahora, Bilbot debería estar encendido.

Licencia

Copyright © 2016, Nebil Kawas García
El código de este repositorio está bajo el Mozilla Public License v2.0.