Skip to main content

A.X.E.L.

Automated X-electronic Engineering Link

Assistente técnico via CLI, especializado em debug e otimização de código Python e queries SQL. Interpreta descrições em linguagem natural, classifica a intenção do pedido e responde com diagnóstico estruturado — sem inventar causas quando falta contexto.

Overview

O AXEL nasceu como desafio do bootcamp DIO (Dados, IA Generativa e Cibersegurança) e evoluiu para uma implementação autoral com foco em Engenharia de Prompt e arquitetura desacoplada. Detalhes de escopo e decisões de produto em docs/product_brief.md; detalhes técnicos de arquitetura em docs/architecture.md.

Problem

Transformar descrições informais de bugs, lentidão ou erros em diagnósticos objetivos e acionáveis — sem exigir que o usuário formule a pergunta de forma técnica.

Architecture

Pipeline desacoplado: classificação de intenção → montagem de prompt em camadas → chamada ao LLM (provider-agnostic, Ollama por padrão) → resposta estruturada. Ver diagrama completo em docs/architecture.md.

Prompt Engineering

Prompts organizados por responsabilidade em app/prompts/: identidade e comportamento (system_prompt.txt), regras de segurança (security_prompt.txt), classificação de intenção (intent_prompt.txt) e formatação de resposta (response_prompt.txt).

Technologies

Python 3.11+, Ollama, requests, rich, pytest.

Security

  • .env nunca versionado (.gitignore); .env.example documenta as variáveis necessárias sem expor valores.
  • System prompt nunca é exposto, mesmo sob pedido direto ou tentativa de prompt injection — regra ativa em security_prompt.txt.
  • Sem execução de código arbitrário fornecido pelo usuário.

Evaluation

Dataset de casos de teste em tests/test_cases.json, cobrindo classificação correta de intenção, pedidos ambíguos e tentativa de prompt injection.

Duas formas de rodar:

# Testes automatizados (pass/fail, integra com CI no futuro)
pytest tests/test_intent.py -v

# Relatório de avaliação com accuracy e histórico (Fase 05)
python -m scripts.run_eval

O segundo comando gera docs/evaluation.md com a accuracy geral e o detalhe de cada caso — é o que deve ser reexecutado a cada iteração de prompt para medir se a mudança melhorou ou piorou os resultados.

Se qualquer um dos dois falhar com erro de conexão, o problema quase sempre é o Ollama não estar rodando — confira ollama serve antes de investigar o código do AXEL. Este projeto não usa Docker nem Postgres; a única dependência externa é o processo do Ollama.

Installation

Duas formas de instalar:

Via pip (recomendado, uma vez publicado):

pip install axel-tech-assistant
axel

A partir do código-fonte (desenvolvimento):

# 1. Instalar e subir o Ollama
# https://ollama.com
ollama pull qwen2.5:1.5b
# se sua máquina tiver pouca RAM (≤4GB) e mesmo assim faltar memória,
# use qwen2.5:0.5b (ainda mais leve) e ajuste OLLAMA_MODEL no .env
ollama serve

# 2. Ambiente Python
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate
pip install -r requirements.txt

# 3. Configurar variáveis
cp .env.example .env

Nos dois casos, o Ollama continua sendo pré-requisito rodando na máquina de quem usa — ver docs/architecture.md, seção "Por que não há deploy tradicional", para o raciocínio completo por trás dessa decisão.

Usage

python -m app.main
você > minha query SQL está demorando 20s para 50 mil registros
AXEL: DIAGNÓSTICO
...

Comandos disponíveis no CLI: sair (encerra), /historico (lista os turnos da sessão atual), /limpar (apaga o histórico).

Memória entre execuções (opcional): por padrão o histórico é só em RAM e some ao fechar o CLI. Para persistir entre execuções (útil se você fecha e reabre o terminal no mesmo problema), configure no .env:

AXEL_MEMORY_BACKEND=sqlite

Isso grava as mensagens num arquivo axel_history.db local (nunca vai pro Git — está no .gitignore, mesma lógica do .env). É opt-in de propósito: persistir significa guardar trechos de código em texto puro em disco.

Deployment

Não definido ainda — depende da stack final avaliada após validação do MVP local (ver docs/product_brief.md, seção Limitações).

Roadmap

  • v1 (atual): CLI, domínio Python/SQL, Ollama local.
  • v2: persistência de memória, análise de dados como segundo domínio.
  • v3: API REST, provider de produção (API paga) como alternativa ao Ollama.

Author

Projeto desenvolvido como parte do bootcamp DIO (Bradesco — Dados, Cibersegurança e IA Generativa), evoluído para implementação autoral.

Metadata

Release files for axel-tech-assistant 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for axel-tech-assistant 0.1.0
File Size Uploaded Provenance
axel_tech_assistant-0.1.0.tar.gz 19.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for axel-tech-assistant 0.1.0
File Interpreter ABI Platform
axel_tech_assistant-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 41.6 kB

Release files / axel_tech_assistant-0.1.0.tar.gz

Download URL axel_tech_assistant-0.1.0.tar.gz
Size 19.7 kB
Tags Source
SHA-256 checksum
How to use checksums
91d995a3a0f5b1f831f193dd27d184eb662442077a19a2dcb15296aee1a9f89d
BLAKE2b-256 checksum
How to use checksums
16a3c5ba2e5702563055eca218c34cfacb782b8d283c9f1664d27acc12c9c79c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / axel_tech_assistant-0.1.0-py3-none-any.whl

Download URL axel_tech_assistant-0.1.0-py3-none-any.whl
Size 21.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
36fb4888648daa91b054b847504dbf9f9ff2db7d0c08fd91e9d807b45332ffd2
BLAKE2b-256 checksum
How to use checksums
e321c171ddf0f90c579027af084de55a5c8337f12ace35fc57aa4c8b78b8222a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Security for axel-tech-assistant 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page