operx-cli 0.7.0__tar.gz → 0.7.2__tar.gz

{operx_cli-0.7.0 → operx_cli-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: operx-cli
-Version: 0.7.0
+Version: 0.7.2
 Summary: La línea de comandos de OperX: tu empresa desde la terminal, con tu token de API.
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{operx_cli-0.7.0 → operx_cli-0.7.2}/operx_cli/AGENTES.md

@@ -59,17 +59,19 @@ llamada queda en el historial del token, marcada como hecha desde la CLI.
 
 - Todos los comandos que escriben aceptan `--json`: la salida es solo la
   respuesta de la API (el registro, con su `id`). Úsalo para encadenar pasos.
-- Escriben: `ordenes crear`, `ordenes editar`, `ordenes estado`,
-  `ordenes asignar`, `ordenes comentar`, `ordenes adjuntar`, `ordenes repuesto`,
-  `preventivos crear`, `preventivos nota`, `equipos crear`, `equipos editar`,
-  `equipos parar`, `equipos reanudar`, `equipos hallazgo`,
-  `equipos hallazgo-a-orden`, `clientes crear`,
-  `clientes editar`, `lugares crear`, `articulos crear`, `inventario entrada`, `inventario salida`, `inventario ajuste`,
-  `inventario traslado`, `inventario revertir`, `lecturas registrar`,
-  `lecturas anular`, `personas importar --confirmar`, `personas ausencia`, `sst nueva-accion`,
-  `sst accion-hecha`, `ambiental nueva-accion`, `ambiental accion-hecha`,
-  `ambiental residuo`, `ambiental lectura`, `avisos --marcar-leidos`, y
-  `operx api` con POST, PUT, PATCH o DELETE. Todos llevan `--si`.
+- Escriben, y todos llevan `--si`:
+  - Trabajos: `ordenes crear`, `editar`, `estado`, `asignar`, `comentar`,
+    `adjuntar` y `repuesto`; `preventivos crear` y `nota`.
+  - Registros: `equipos crear` y `editar`, `clientes crear` y `editar`,
+    `lugares crear`.
+  - Inventario: `articulos crear`; `inventario entrada`, `salida`, `ajuste`,
+    `traslado` y `revertir`.
+  - Equipos: `equipos parar`, `reanudar`, `hallazgo` y `hallazgo-a-orden`;
+    `lecturas registrar` y `anular`.
+  - Personas: `personas importar --confirmar` y `personas ausencia`.
+  - SG-SST y Ambiental: `sst nueva-accion` y `accion-hecha`;
+    `ambiental nueva-accion`, `accion-hecha`, `residuo` y `lectura`.
+  - `avisos --marcar-leidos`, y `operx api` con POST, PUT, PATCH o DELETE.
 - Un error se corrige con su contrario, nunca borrando: `inventario revertir`
   deshace un movimiento, `lecturas anular` una lectura.
 - SG-SST y Ambiental van por empresa: sin `--empresa`, la de la cuenta. Una
@@ -177,22 +179,22 @@ operx api GET work-orders/export/ -o ordenes.csv
 operx ordenes listar --vencidas --asignada-a yo --todas --json
 
 # Pasar una orden a completada, después de su sí
-operx ordenes estado 1234 completada --si
+operx ordenes estado 1234 completada --si --json
 
 # Registrar una lectura: primero el número del punto
 operx lecturas puntos BOM-04 --json
-operx lecturas registrar --punto 12 --valor 73,4 --si
+operx lecturas registrar --punto 12 --valor 73,4 --si --json
 
 # Sacar stock: primero el código y el lugar exactos
 operx inventario existencias --buscar filtro --json
-operx inventario salida --articulo FIL-010 --lugar "Bodega central" --cantidad 2 --motivo Consumo --si
+operx inventario salida --articulo FIL-010 --lugar "Bodega central" --cantidad 2 --motivo Consumo --si --json
 
 # Un artículo nuevo y lo que llegó de él (crear da el código)
-operx articulos crear --nombre "Filtro de aceite" --unidad und --tipo consumible --si
-operx inventario entrada --articulo CON-0001 --lugar "Bodega central" --cantidad 10 --costo-unitario 25.000 --si
+operx articulos crear --nombre "Filtro de aceite" --unidad und --tipo consumible --si --json
+operx inventario entrada --articulo CON-0001 --lugar "Bodega central" --cantidad 10 --costo-unitario 25.000 --si --json
 
 # Un equipo que entró a mantenimiento
-operx equipos editar BOM-04 --estado en-mantenimiento --si
+operx equipos editar BOM-04 --estado en-mantenimiento --si --json
 
 # Un repuesto usado en una orden, y lo que ya lleva
 operx ordenes repuesto 1234 --articulo FIL-010 --lugar "Bodega central" --cantidad 2 --si --json
@@ -229,5 +231,5 @@ operx sst acciones --estado abiertas --json
 
 # Lo que vence este mes en lo ambiental, y registrar residuos
 operx ambiental obligaciones --json
-operx ambiental residuo --corriente "Aceite usado" --kg 12,5 --si
+operx ambiental residuo --corriente "Aceite usado" --kg 12,5 --si --json
 ```

{operx_cli-0.7.0 → operx_cli-0.7.2}/operx_cli/__init__.py

@@ -2,4 +2,4 @@
 API (backend/users/api_allowlist.py) from a terminal, with a personal API
 token."""
 
-__version__ = "0.7.0"
+__version__ = "0.7.2"

{operx_cli-0.7.0 → operx_cli-0.7.2}/operx_cli/api_fields.py

@@ -2,15 +2,21 @@
 (auth/api-tokens/schema/, drf-spectacular): the values in its address, its
 filters, the fields of its body and what it answers. `operx api campos`
 prints it, so an AI agent can call any route with `operx api` without
-guessing; no network here, so the MCP server can use it as it is.
+guessing; no network here, so the MCP server can use it as it is: its
+image copies this one file (mcp/Dockerfile), so keep it free of imports
+beyond the standard library.
 
 The schema's shapes this follows: a field's type behind a $ref; an allOf
 of one $ref (a nested record); a oneOf of an enum with BlankEnum and
 NullEnum (a choice that may be "" or null); each enum's labels in its
 description, one "* `value` - Label" a line.
+
+It also lists the routes and finds them by words (`operx api rutas`, the
+MCP's operx_rutas).
 """
 
 import re
+import unicodedata
 
 METHODS = ("get", "post", "put", "patch", "delete")
 # A field inside a list inside a list… is shown this many levels deep.
@@ -230,3 +236,40 @@ def _answer(components, operation):
             record = _resolve(components, record.get("items"))
         return {"estado": int(status), "pagina": paged, "campos": list(record.get("properties", {}))}
     return {"estado": None, "pagina": False, "campos": []}
+
+
+def routes_of(schema):
+    """Every route of the schema, one row per method: its address, its
+    product (the docs' section, in Spanish) and its description."""
+    routes = []
+    for path, operations in schema.get("paths", {}).items():
+        for method, operation in operations.items():
+            if method not in METHODS:
+                continue
+            # The first paragraph: the docs add a note on the token a write needs.
+            description = (operation.get("description") or "").split("\n\n")[0].strip()
+            if description.startswith("Necesita un token"):
+                description = ""
+            routes.append({
+                "metodo": method.upper(), "ruta": path.removeprefix("/api/v1/"),
+                # The docs' section: the product, in Spanish ("SG-SST", "Inventario").
+                "producto": ", ".join(operation.get("tags", [])), "descripcion": description,
+            })
+    return routes
+
+
+def plain(text):
+    """'Órdenes' → 'ordenes': no case, no accents."""
+    return "".join(char for char in unicodedata.normalize("NFKD", text.casefold()) if not unicodedata.combining(char))
+
+
+def mentions(where, text):
+    """Whether every word of `text` is in `where`, a plural also as its
+    singular: an agent asks for "repuestos" where the docs say "repuesto",
+    and "ordenes" for "órdenes"."""
+    where = plain(where)
+    for word in plain(text).split():
+        singular = word[:-2] if word.endswith("es") and len(word) > 5 else word.rstrip("s") if len(word) > 4 else word
+        if word not in where and singular not in where:
+            return False
+    return True

{operx_cli-0.7.0 → operx_cli-0.7.2}/operx_cli/commands/raw.py

@@ -2,7 +2,6 @@
 lists them), for what has no command of its own yet."""
 
 import json
-import unicodedata
 from contextlib import ExitStack
 from pathlib import Path
 from typing import Annotated, Optional
@@ -10,7 +9,7 @@ from typing import Annotated, Optional
 import typer
 from rich.text import Text
 
-from ..api_fields import describe, find_route, methods_of
+from ..api_fields import describe, find_route, mentions, methods_of, routes_of
 from ..client import ApiError, api_path
 from ..output import json_text, note, print_rows, screen_console
 from .common import AllOption, CliError, YesOption, client_of, confirm_write
@@ -60,9 +59,9 @@ def _print_routes(client, text, as_json):
     """Every call the token may make, from the API's own docs
     (users/api_docs.py): the method, the address as `operx api` takes it,
     and what the docs say. `text` keeps the ones that mention it."""
-    routes = _routes(client.get("auth/api-tokens/schema"))
+    routes = routes_of(client.get("auth/api-tokens/schema"))
     if text:
-        routes = [route for route in routes if _mentions(f"{route['ruta']} {route['producto']} {route['descripcion']}", text)]
+        routes = [route for route in routes if mentions(f"{route['ruta']} {route['producto']} {route['descripcion']}", text)]
     print_rows(ROUTE_COLUMNS, routes, "json" if as_json else "tabla")
     if not as_json and routes:
         note("Lo que lleva cada una: operx api campos RUTA")
@@ -169,41 +168,6 @@ def _print_fields(client, ruta, method, as_json):
             console.print(Text(f"Responde ({answer['estado']}) {what}: {', '.join(answer['campos'])}".replace(" :", ":"), style="dim"))
 
 
-def _plain(text):
-    """'Órdenes' → 'ordenes': no case, no accents."""
-    return "".join(char for char in unicodedata.normalize("NFKD", text.casefold()) if not unicodedata.combining(char))
-
-
-def _mentions(where, text):
-    """Whether every word of `text` is in `where`, a plural also as its
-    singular: an agent asks for "repuestos" where the docs say "repuesto",
-    and "ordenes" for "órdenes"."""
-    where = _plain(where)
-    for word in _plain(text).split():
-        singular = word[:-2] if word.endswith("es") and len(word) > 5 else word.rstrip("s") if len(word) > 4 else word
-        if word not in where and singular not in where:
-            return False
-    return True
-
-
-def _routes(schema):
-    routes = []
-    for path, operations in schema.get("paths", {}).items():
-        for method, operation in operations.items():
-            if method.upper() not in METHODS:
-                continue
-            # The first paragraph: the docs add a note on the token a write needs.
-            description = (operation.get("description") or "").split("\n\n")[0].strip()
-            if description.startswith("Necesita un token"):
-                description = ""
-            routes.append({
-                "metodo": method.upper(), "ruta": path.removeprefix("/api/v1/"),
-                # The docs' section: the product, in Spanish ("SG-SST", "Inventario").
-                "producto": ", ".join(operation.get("tags", [])), "descripcion": description,
-            })
-    return routes
-
-
 def _show(response, salida):
     if salida:
         salida.write_bytes(response.content)

{operx_cli-0.7.0 → operx_cli-0.7.2}/operx_cli/lookup.py

@@ -3,6 +3,9 @@
 Only an exact match counts, ignoring case and extra spaces: a search's first
 hit is never taken, so "Bodega" can't move stock into "Bodega central norte".
 A number nobody is called is taken as the record's id.
+
+The MCP server uses find_in as it is: its image copies this one file
+(mcp/Dockerfile), so keep it free of imports.
 """
 
 

{operx_cli-0.7.0 → operx_cli-0.7.2}/operx_cli/shell.py

@@ -10,16 +10,19 @@ terminal (Git Bash, a pipe)."""
 import os
 import re
 import shlex
+import traceback
 
 import typer
 from rich.console import Console
 from rich.text import Text
 
-from . import settings
+from . import __version__, settings
 from .output import print_aligned
 from .record_completion import RecordNames, completion_text
 
 PROMPT = "operx › "
+# Where the CLI's own files are: a crash names its line closest to the error.
+PACKAGE_FOLDER = os.path.normcase(os.path.dirname(os.path.abspath(__file__)))
 STOP_WORDS = ("salir", "exit", "quit")
 HELP_WORDS = ("/ayuda", "ayuda", "/help", "help", "?")
 CLEAR_WORDS = ("limpiar", "/limpiar", "clear", "cls")
@@ -169,6 +172,31 @@ def print_help(root, console, products=None):
     console.print(Text("Escribe un comando con --help para ver sus opciones.", style="dim"))
 
 
+def where_it_failed(error):
+    """The CLI's own line closest to the error, as "commands/search.py:22".
+    run_command, which caught it, is always one of them."""
+    frames = traceback.extract_tb(error.__traceback__)
+    ours = [frame for frame in frames if os.path.normcase(frame.filename).startswith(PACKAGE_FOLDER)]
+    if not ours:
+        return "?"
+    relative = os.path.relpath(ours[-1].filename, PACKAGE_FOLDER)
+    return f"{relative.replace(os.sep, '/')}:{ours[-1].lineno}"
+
+
+def crash_message(error):
+    """What a crash says inside the session: a line a person can send to
+    support (the error, where in the CLI, and the version those line numbers
+    belong to), never what was typed, which can hold anything."""
+    what = type(error).__name__
+    lines = str(error).strip().splitlines()
+    if lines:
+        what = f"{what}: {lines[0]}"
+    return (
+        f"Error: algo falló ({what}; en {where_it_failed(error)}, operx {__version__}).\n"
+        "Para ver todo el detalle, corre el mismo comando con operx delante, fuera de esta sesión."
+    )
+
+
 def run_command(session, root, argv):
     """One command, as `operx` would run it, but an error never ends the session."""
     try:
@@ -181,7 +209,7 @@ def run_command(session, root, argv):
         if hasattr(error, "format_message"):
             typer.echo(f"Error: {spanish_usage_error(error)}", err=True)
         else:
-            typer.echo(f"Error: algo falló ({type(error).__name__}).", err=True)
+            typer.echo(crash_message(error), err=True)
 
 
 def handle_line(session, root, line, console, products=None):

{operx_cli-0.7.0 → operx_cli-0.7.2}/operx_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: operx-cli
-Version: 0.7.0
+Version: 0.7.2
 Summary: La línea de comandos de OperX: tu empresa desde la terminal, con tu token de API.
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{operx_cli-0.7.0 → operx_cli-0.7.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "operx-cli"
-version = "0.7.0"
+version = "0.7.2"
 description = "La línea de comandos de OperX: tu empresa desde la terminal, con tu token de API."
 readme = "README.md"
 requires-python = ">=3.10"

{operx_cli-0.7.0 → operx_cli-0.7.2}/tests/test_completar.py

@@ -3,6 +3,7 @@ writes a small script to operx's folder and, after asking, one line in the
 PowerShell profile that loads it; `--quitar` takes both away."""
 
 import os
+import sys
 from pathlib import Path
 
 import pytest
@@ -31,6 +32,7 @@ def test_the_script_completes_operx_and_leaves_tab_alone_elsewhere():
     script.encode("ascii")
 
 
+@pytest.mark.skipif(sys.platform != "win32", reason="PowerShell's profile is a Windows path")
 def test_the_profile_line_names_the_folder_by_appdata(tmp_path):
     """No user name in the line: a profile saved in another encoding can't
     garble it."""

{operx_cli-0.7.0 → operx_cli-0.7.2}/tests/test_shell.py

@@ -3,7 +3,7 @@ import pytest
 import typer.main
 from typer.testing import CliRunner
 
-from operx_cli import settings
+from operx_cli import __version__, settings
 from operx_cli.app import app
 from operx_cli.commands.common import Session
 from operx_cli.shell import STOP_WORDS, run_shell, split_line, suggestions
@@ -183,6 +183,23 @@ def test_a_refused_call_shows_the_apis_words_and_the_session_goes_on(capsys):
     assert "Ana Ruiz" in out.out
 
 
+def test_a_crash_says_what_failed_and_where_and_the_session_goes_on(capsys):
+    # A list where the CLI expects an object: an answer it doesn't know.
+    fake = FakeApi({("GET", "search/"): [{"kind": "employee", "id": 4, "title": "Ana Ríos"}], ("GET", "auth/me/"): ME})
+
+    shell(fake, "buscar prensa-zeta-77", "cuenta")
+
+    out = capsys.readouterr()
+    # The line a person sends to support: the error, the CLI's own line where
+    # it happened and the version, whose line numbers those are.
+    assert "AttributeError: 'list' object has no attribute 'get'" in out.err
+    assert "commands/search.py:" in out.err
+    assert f"operx {__version__}" in out.err
+    # Not what was typed: it can hold anything, a token included.
+    assert "prensa-zeta-77" not in out.err
+    assert "Ana Ruiz" in out.out
+
+
 def test_help_inside_the_shell_does_not_end_it(capsys):
     shell(FakeApi({("GET", "auth/me/"): ME}), "ordenes --help", "cuenta")
     assert "Ana Ruiz" in capsys.readouterr().out