trackops 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,193 @@
1
+ # El Ciclo O.P.E.R.A. — Referencia Completa
2
+
3
+ Este documento detalla cada fase del ciclo con sus reglas, procedimientos y Definitions of Done.
4
+
5
+ ---
6
+
7
+ ## 1️⃣ O — Orquestar (Visión y Lógica)
8
+
9
+ ### Descubrimiento
10
+
11
+ Haz al usuario las 5 preguntas clave:
12
+
13
+ 1. **Directriz Principal**: ¿Cuál es el resultado singular deseado?
14
+ 2. **Integraciones**: ¿Qué servicios externos necesitamos? ¿Están listas las claves?
15
+ 3. **Fuente de la Verdad**: ¿Dónde viven los datos primarios?
16
+ 4. **Carga Útil (Payload)**: ¿Cómo y dónde debe entregarse el resultado final?
17
+ 5. **Reglas de Comportamiento**: Restricciones o tono específico.
18
+
19
+ ### Regla "Datos-Primero"
20
+
21
+ Antes de pasar a la siguiente fase, DEBES definir el **Esquema de Datos JSON** (Input/Output) en `genesis.md`.
22
+
23
+ Ejemplo de schema en genesis.md:
24
+
25
+ ```json
26
+ {
27
+ "input": {
28
+ "source": "API externa",
29
+ "schema": {
30
+ "id": "string (UUID)",
31
+ "timestamp": "ISO 8601",
32
+ "data": "object"
33
+ }
34
+ },
35
+ "output": {
36
+ "destination": "webhook POST",
37
+ "schema": {
38
+ "processed_id": "string (UUID)",
39
+ "result": "object",
40
+ "status": "enum: success|error"
41
+ }
42
+ }
43
+ }
44
+ ```
45
+
46
+ ### Definition of Done — Fase O
47
+
48
+ - [ ] Las 5 preguntas de descubrimiento están respondidas.
49
+ - [ ] Esquema JSON de Input/Output definido en `genesis.md`.
50
+ - [ ] Reglas de comportamiento documentadas en `genesis.md`.
51
+ - [ ] `task_plan.md` tiene plano aprobado por el usuario.
52
+
53
+ ---
54
+
55
+ ## 2️⃣ P — Probar (Conectividad)
56
+
57
+ Verifica las tuberías antes de pasar el agua. El objetivo es confirmar que todos los servicios externos responden y devuelven datos con la forma esperada.
58
+
59
+ ### Procedimiento
60
+
61
+ 1. **Verificación de credenciales**: Lee `.env` y confirma que todas las claves necesarias existen y no están vacías.
62
+ 2. **Handshake**: Construye scripts mínimos en `tools/` (ej: `test_api.py`) para verificar cada servicio.
63
+ 3. **Validación de Shape**: No basta con un HTTP 200. Verifica que la respuesta coincide con el schema definido en `genesis.md`. Compara campos, tipos de datos y estructura.
64
+ 4. **Bloqueo**: Si algún test falla, NO procedas a la fase de Estructurar. Documenta el fallo en `findings.md`.
65
+
66
+ ### Ejemplo de test mínimo
67
+
68
+ ```python
69
+ # tools/test_api.py
70
+ import os
71
+ import requests
72
+
73
+ API_KEY = os.getenv("API_KEY")
74
+ BASE_URL = os.getenv("API_BASE_URL")
75
+
76
+ def test_connection():
77
+ """Verifica conexión y shape de respuesta."""
78
+ response = requests.get(f"{BASE_URL}/health", headers={"Authorization": f"Bearer {API_KEY}"})
79
+ assert response.status_code == 200, f"Expected 200, got {response.status_code}"
80
+ data = response.json()
81
+ assert "id" in data, "Missing 'id' field in response"
82
+ assert "status" in data, "Missing 'status' field in response"
83
+ print("✅ API connection and shape validated")
84
+
85
+ if __name__ == "__main__":
86
+ test_connection()
87
+ ```
88
+
89
+ ### Definition of Done — Fase P
90
+
91
+ - [ ] Todas las credenciales `.env` verificadas (existen y no están vacías).
92
+ - [ ] Scripts `test_*.py` ejecutados y pasando.
93
+ - [ ] Respuestas de APIs validadas contra el schema de `genesis.md`.
94
+ - [ ] Resultados documentados en `findings.md`.
95
+
96
+ ---
97
+
98
+ ## 3️⃣ E — Estructurar (La Construcción de 3 Capas)
99
+
100
+ ### Capa 1: Arquitectura (`architecture/`)
101
+
102
+ SOPs (Standard Operating Procedures) técnicos en Markdown. Cada SOP define:
103
+
104
+ - Propósito del script.
105
+ - Entradas esperadas (con referencia al schema en `genesis.md`).
106
+ - Salidas producidas.
107
+ - Casos extremos y cómo manejarlos.
108
+ - Dependencias con otras herramientas.
109
+
110
+ **Regla**: Si la lógica cambia, actualiza el SOP **antes** que el código.
111
+
112
+ ### Capa 2: Navegación (El Agente)
113
+
114
+ Capa de razonamiento. Enruta datos entre SOPs y herramientas. No ejecuta lógica de negocio directamente; delega a los scripts.
115
+
116
+ ### Capa 3: Herramientas (`tools/`)
117
+
118
+ - Scripts atómicos y deterministas.
119
+ - Las variables de entorno van en `.env`.
120
+ - Usa `.tmp/` para todas las operaciones intermedias.
121
+ - Cada script hace UNA cosa bien.
122
+
123
+ ### Regla de Idempotencia
124
+
125
+ Toda herramienta DEBE ser idempotente. Herramientas con side-effects irreversibles se marcan:
126
+
127
+ ```python
128
+ # META: side-effect: true
129
+ # META: idempotent: false
130
+ # META: requires-confirmation: true
131
+ ```
132
+
133
+ ### Grafo de Dependencias
134
+
135
+ Si una herramienta produce output que consume otra, documéntalo en `genesis.md` bajo `## Pipeline`:
136
+
137
+ ```markdown
138
+ ## Pipeline
139
+ ### tool_fetch.py → tool_transform.py
140
+ - Output: `.tmp/raw_data.json`
141
+ - Formato: JSON array según schema X
142
+ ```
143
+
144
+ ### Definition of Done — Fase E
145
+
146
+ - [ ] SOPs escritos en `architecture/` para cada herramienta.
147
+ - [ ] Scripts implementados en `tools/`.
148
+ - [ ] Grafo de dependencias documentado en `genesis.md`.
149
+ - [ ] Tests de integración entre herramientas pasando.
150
+ - [ ] Herramientas con side-effects marcadas con META tags.
151
+
152
+ ---
153
+
154
+ ## 4️⃣ R — Refinar (Refinamiento)
155
+
156
+ ### Templates de Output
157
+
158
+ Toda salida del sistema se valida contra una plantilla definida en `templates/`. Las plantillas se referencian desde `genesis.md` bajo `## Templates`.
159
+
160
+ El refinamiento no es subjetivo; es verificable contra una plantilla. Si el output no coincide con el template, no pasa.
161
+
162
+ ### Refinamiento de Carga Útil
163
+
164
+ Formatea todas las salidas (Markdown, HTML, JSON limpio) para entrega profesional según lo definido en `genesis.md`.
165
+
166
+ ### UX/UI
167
+
168
+ Si el proyecto tiene interfaz, aplica diseños limpios e intuitivos según las especificaciones.
169
+
170
+ ### Definition of Done — Fase R
171
+
172
+ - [ ] Todas las salidas validadas contra sus templates en `templates/`.
173
+ - [ ] Formatos de entrega (Markdown, HTML, JSON) verificados.
174
+ - [ ] Si hay interfaz: revisión visual completada.
175
+
176
+ ---
177
+
178
+ ## 5️⃣ A — Automatizar (Despliegue)
179
+
180
+ ### Procedimiento
181
+
182
+ 1. **Limpieza**: Elimina residuos de `.tmp/`.
183
+ 2. **Transferencia**: Mueve la lógica finalizada a producción/nube.
184
+ 3. **Configuración**: Establece los disparadores (Cron, Webhooks).
185
+ 4. **Smoke Test**: Verificación mínima en el entorno de producción.
186
+
187
+ ### Definition of Done — Fase A
188
+
189
+ - [ ] `.tmp/` limpio (sin archivos residuales).
190
+ - [ ] Código desplegado en destino final.
191
+ - [ ] Triggers configurados y verificados.
192
+ - [ ] Smoke test en producción pasando.
193
+ - [ ] `progress.md` actualizado con estado final.