ApiConsultor

Consultor offline de APIs Python y documentación local. Indexa docstrings y ficheros (.txt, .md, .rst, .zip) en SQLite y responde con un LLM local vía Ollama (qwen3:8b + bge-m3), citando las fuentes.

Instalación

Requisitos: Python 3.12+, uv y Ollama en marcha.

uv tool install api-consultor
api setup        # descarga los modelos y ofrece indexar la biblioteca estándar

Actualizar: uv tool upgrade api-consultor (y api setup si cambió el Modelfile).

Uso

api index requests rich           # paquetes del entorno de la herramienta
api index pygame -p .venv         # ... o de un entorno virtual de tu proyecto
api index --stdlib                # biblioteca estándar
api index-docs [CARPETA]          # documentación local
api ask                           # entra en chat interactivo
api ask -s requests "..."         # pregunta solo sobre una fuente (repetible)
api sources                       # qué hay indexado (--update, --remove, --relocate)

api --help y api COMANDO --help describen todas las opciones.

Configuración

api config muestra los valores efectivos, las rutas de datos y, si no existe, ofrece crear un config.toml comentado. Solo hace falta indicar lo que cambies:

[models]      # chat, embed, embed_dim
[paths]       # db, docs
[retrieval]   # k, candidates, max_per_symbol, max_distance
[display]     # width
[links]       # url, p. ej. "vscode://file/{path}:{line}"

Documentación avanzada

• Uso detallado: todos los comandos, entornos --python, estados de las fuentes.
• Configuración: rutas, opciones de config.toml, enlaces a editores, Modelfile.
• Cómo funciona: indexado, recuperación híbrida, citas, integridad del índice y limitaciones.
• Evaluar la recuperación: api eval, métricas y formato de los casos.
• Desarrollo: calidad, CI y publicación en PyPI.

Desarrollo

git clone https://github.com/isidro-rodriguez/api-consultor
cd api-consultor
uv sync && uv run pre-commit install
uv run pytest            # ruff, ty y pytest también corren en pre-commit / pre-push

Las versiones se publican en PyPI al subir una etiqueta vX.Y.Z. Detalles en AGENTS.md y CHANGELOG.md.