evrz hackathon

Bot de revisión de Telegram

Un bot de telegrama de Python que procesa archivos de archivo, extrae estructuras de proyecto, código analizador y genera un informe de revisión basado en la base de conocimiento proporcionada.

Características

• Soporte de archivo: acepta varios formatos de archivo.
• Soporte del archivo: acepta formatos de archivo RAR, ZIP y 7Z.
• Vista previa de revisión: Envía una vista previa paginada de los resultados de la revisión.
• Revisión de descarga: proporciona un botón para descargar el informe de revisión completo como un archivo PDF.
• Rag: utiliza RAG para proporcionar contexto para el modelo.
• Small LLM: utiliza el modelo Mistral-Nemo 12B para ofrecer una revisión integral que requiere menos de 20 GB de VRAM.

Configuración

Requisitos previos

• Python 3.11+
• Poesía para la gestión de la dependencia. Instalar desde el sitio oficial de la poesía
• Minio servidor con registro de DNS para URL preasignadas (las credenciales se proporcionarán por separado)
• Dependencias del sistema :
  • Para la extracción de RAR, asegúrese de que unrar esté instalado en su sistema:
    • Ubuntu: sudo apt-get install unrar
    • MacOS (con HomeBrew): brew install unrar
    • Windows: no es compatible debido a la falta de bibliotecas compatibles.

Nota importante para el desarrollo local

Si ejecuta el bot localmente (fuera de Docker), deberá manejar la instalación de Pytorch por separado:

• O Ejecutar: pip install torch==2.1.2 --index-url https://download.pytorch.org/whl/cpu
• O desenchufe la dependencia de torch en pyproject.toml e intente instalarla, pero puede fallar .

Instalación

1. Clonar el repositorio

   git clone https://github.com/isofinly/telegram_review_bot.git
   cd telegram_review_bot

2. Configurar las variables de entorno Cree un archivo .env con las siguientes variables requeridas:

    BOT_TOKEN=your_telegram_bot_token
   MINIO_ENDPOINT=your_minio_endpoint
   MINIO_ACCESS_KEY=your_minio_access_key
   MINIO_SECRET_KEY=your_minio_secret_key
   MINIO_SECURE=true_or_false
   MODEL_API_KEY=your_model_api_key
   

   Nota: Se proporcionarán minio credenciales a través del administrador y el documento de la unidad de nube.

3. Elija su método de instalación

   Docker (recomendado) :

   docker-compose up -d

   Esto iniciará los contenedores BOT y Minio Server.

   Instalación local :

   poetry install
   poetry run telegram-review-bot

Uso

1. Comienza el bot

   Abra telegrama y busque su bot. Comience una conversación enviando /start .

2. 2.1 Enviar un archivo

   Envíe un archivo al bot.

   2.2 Enviar un archivo

   O puede enviar un archivo de archivo (rar, zip, 7z) al bot.

3. Recibir salidas

   • Vista previa de revisión: El bot responderá con la vista previa paginada de los resultados de la revisión.
   • Revisión de descarga: use el botón proporcionado para descargar el informe de revisión completo como un archivo PDF.

Revisión de la tubería

1. Rag : cree una base de datos vectorial a partir de la base de conocimiento para alinear los fragmentos de código con ejemplos de revisión relevantes.
2. Revisar :
   • Estructura del proyecto de análisis
   • Analizar la estructura de archivos individuales.
   • Divide los archivos en fragmentos manejables.
   • Use RAG para generar indicaciones e información contextual para el modelo.
   • Generar y formatear la revisión

Estructura de paquetes

• src/bot - Código de Bot de telegrama.
• src/review - Lógica de revisión del código.
• • src/review/parsers - Lógica de fragmentación de código

Que contribuye

¡Las contribuciones son bienvenidas! Abra un problema o envíe una solicitud de extracción para cualquier mejoras o correcciones de errores.

Licencia

MIT