CLI local para conciliacion bancaria (Chile-first) con auditoria y enfoque fail-closed.
Project description
Conciliador Bancario (MVP)
CLI local (Chile-first) para conciliación bancaria con enfoque fail-closed, auditabilidad y salidas deterministas.
Vista rápida (inputs → proceso → outputs)
Entradas (por cliente) Proceso (core) Salidas (por corrida = run_dir)
config_cliente.yaml ┐ ┌─ run.json (resultado técnico + contrato)
banco.csv|xlsx|xml|pdf ├─> ingestión -> normalización -> matching -> ├─ audit.jsonl (traza append-only, JSON Lines)
esperados.csv|xlsx ┘ validación estricta + auditoría └─ reporte_conciliacion.xlsx (opcional; revisión humana)
Puntos no negociables:
- Fail-closed: ante ambigüedad o baja confianza, el sistema no autoconcilia.
- Sin errores silenciosos: validación estricta; errores explícitos.
- Auditable: evidencia técnica (
run.json,audit.jsonl, XLSX). - Determinista: misma entrada → mismo
run.json(sin timestamps variables).
Qué hace (y qué no)
Qué hace
- Concilia movimientos del banco (cartola/extracto) contra movimientos esperados (ERP/planilla/registros internos).
- Genera matches y hallazgos (pendientes, advertencias, riesgos) con explicación.
- Produce artefactos reproducibles para cierre mensual y auditoría.
Qué NO hace
- No se conecta a bancos, no descarga datos, no usa APIs bancarias.
- No es un ERP ni “reemplaza” criterio contable.
- No “adivina” para maximizar autoconciliación (por diseño, prioriza control de daño).
- No es SaaS: no hay telemetría ni envío de datos (todo corre local).
Quick Start (5 minutos)
1) Instalar (pipx, recomendado)
# Desde PyPI (recomendado):
pipx install bankrecon
# Desde el repo (desarrollo):
pipx install .
concilia --help
OCR (opcional para PDFs escaneados):
pipx inject bankrecon pdf2image pytesseract Pillow
2) Inicializar un “cliente”
concilia init --out-dir .\mi_cliente
Esto crea plantillas:
.\mi_cliente\config_cliente.yaml.\mi_cliente\banco.csv.\mi_cliente\movimientos_esperados.csv
3) Validar inputs (antes de correr)
concilia validate --config .\mi_cliente\config_cliente.yaml --bank .\mi_cliente\banco.csv --expected .\mi_cliente\movimientos_esperados.csv
4) Ejecutar (modo seguro primero)
concilia run --config .\mi_cliente\config_cliente.yaml --bank .\mi_cliente\banco.csv --expected .\mi_cliente\movimientos_esperados.csv --out .\salida --dry-run
Luego, para generar XLSX:
concilia run --config .\mi_cliente\config_cliente.yaml --bank .\mi_cliente\banco.csv --expected .\mi_cliente\movimientos_esperados.csv --out .\salida
5) Explicar un caso puntual
concilia explain --run-dir .\salida M-<match_id>
concilia explain --run-dir .\salida H-<hallazgo_id>
Formatos soportados (MVP)
- Banco: CSV / XLSX / XML / PDF (texto).
- PDF escaneado: solo con OCR habilitado (opcional) y siempre con política conservadora (no autoconcilia).
- Movimientos esperados: CSV / XLSX.
Calidad y confianza (lo que mira CI)
Este repo tiene guardrails para bloquear regresiones:
- Formato: Black
- Lint: Ruff
- SAST: Bandit
- SCA (supply-chain): pip-audit (vulnerabilidades en dependencias; ver
.pip-audit-ignore.txt) - SAST semántico: Semgrep (corre en CI sobre Ubuntu; en Windows requiere Docker/WSL)
- Tests: pytest (incluye tests “golden” para outputs contractuales)
Comandos locales:
python -m pip install -e ".[dev]"
python -m black --check src tests tools
python -m ruff check src tests tools
python -m bandit -c .bandit.yml -r src
python tools/pip_audit_gate.py
python -m pytest -q
Semgrep (opcional local):
# Requiere Docker o WSL2; en CI ya está integrado.
docker run --rm -v "${PWD}:/src" -w /src returntocorp/semgrep:1.95.0 semgrep scan --config .semgrep.yml --error --metrics=off src
Contratos y artefactos (Core → Premium)
El artefacto run.json es un contrato versionado para consumo por herramientas externas (incluyendo premium).
- Especificación:
docs/contract_run_json.md - Glosario de términos:
GLOSARIO.md
Documentación
Empiece aquí:
Referencia:
docs/guia_contadores.mddocs/guia_tecnica.mddocs/agregar_formato.mddocs/contract_run_json.mdwalkthrough.mdmvp_checklist.md
Público objetivo
Sí
- Estudios contables, PyMEs y equipos que necesitan un flujo reproducible de conciliación con evidencia.
- Usuarios no técnicos o semi-técnicos que puedan ejecutar comandos y preparar archivos (CSV/XLSX/PDF).
No
- Quien busca integración automática con bancos, sincronización online o una UI gráfica.
- Quien necesita maximizar “auto-match” a costa de riesgo (este proyecto prefiere conservadurismo).
Estado del proyecto
MVP funcional:
concilia init,validate,run,explainoperativos.- Ingestión para CSV/XLSX/XML/PDF texto; OCR opcional.
- Salidas:
run.json,audit.jsonl,reporte_conciliacion.xlsx.
Roadmap (alto nivel, sin promesas de fecha):
- Endurecer compatibilidad por formatos bancarios reales (sin romper contrato).
- Mejoras de ergonomía y documentación operativa.
Versionado y releases
- Source of truth:
src/conciliador_bancario/version.py - Historial de cambios:
CHANGELOG.md - Política (repo público): cada merge a
mainhace bump automático depatch, crea tagvX.Y.Zy (si está configurado) publica en PyPI.
Premium (opcional)
Existe un repositorio premium separado orientado a productividad (revisión/agrupación/priorización), que consume el run_dir generado por este core.
Este repo no incluye el código premium.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bankrecon-0.2.0.tar.gz.
File metadata
- Download URL: bankrecon-0.2.0.tar.gz
- Upload date:
- Size: 76.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b84aad5f7b216cc98e74c666eabf68e438d9e2d062a26ff4a9e04a7ab3994ecb
|
|
| MD5 |
7c5a570c17215f6a7a4149ba12428dc2
|
|
| BLAKE2b-256 |
c59e5809a603fa26cf0dd05bd4fd75b4dd124242cfdb803a3b84a6b3758b9be7
|
Provenance
The following attestation bundles were made for bankrecon-0.2.0.tar.gz:
Publisher:
publish.yml on cortega26/conciliador_bancario
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bankrecon-0.2.0.tar.gz -
Subject digest:
b84aad5f7b216cc98e74c666eabf68e438d9e2d062a26ff4a9e04a7ab3994ecb - Sigstore transparency entry: 938066704
- Sigstore integration time:
-
Permalink:
cortega26/conciliador_bancario@e649f44ae108eb40e1eddb55d2289586a3ca826d -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/cortega26
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@e649f44ae108eb40e1eddb55d2289586a3ca826d -
Trigger Event:
push
-
Statement type:
File details
Details for the file bankrecon-0.2.0-py3-none-any.whl.
File metadata
- Download URL: bankrecon-0.2.0-py3-none-any.whl
- Upload date:
- Size: 45.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7699ae8cd1179b63d1092f5cb0cb73f661155a3e46c9e1d780ca72adab012516
|
|
| MD5 |
52e89d2c9c3eca5ff0738e73af1c2ebe
|
|
| BLAKE2b-256 |
35d18a310b9d9dd186826989acea9357c88bf0e4a01faec8bbc38ae04d72fd3b
|
Provenance
The following attestation bundles were made for bankrecon-0.2.0-py3-none-any.whl:
Publisher:
publish.yml on cortega26/conciliador_bancario
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bankrecon-0.2.0-py3-none-any.whl -
Subject digest:
7699ae8cd1179b63d1092f5cb0cb73f661155a3e46c9e1d780ca72adab012516 - Sigstore transparency entry: 938066718
- Sigstore integration time:
-
Permalink:
cortega26/conciliador_bancario@e649f44ae108eb40e1eddb55d2289586a3ca826d -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/cortega26
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@e649f44ae108eb40e1eddb55d2289586a3ca826d -
Trigger Event:
push
-
Statement type: