Files
docs/mcp/omniread/modules/omniread.xlsx.client.json
Vishesh 'ironeagle' Bangotra 0c25cbb19f feat: unify docs portal and MCP servers into one config-driven service
- add config.yml as single source of truth for collected repos/categories
- add collect.py CLI to pull lib/api/wiki site builds and mcp bundles from
  source repos and regenerate nginx.conf + _index/index.html
- port mcp runtime (main.py/core.py/config.py): nginx + health + FastMCP
  servers started from config.yml
- docker: python:3.13-slim + nginx, expose 8000-8006 + 9000 (html portal)
- drone: publish html (6007:9000) and MCP ports 8000-8006
- move mongo-ops docs to wiki/, add auth-server (api) and hexa (lib)
- refresh lib site builds (lib/ prefix) and collect mcp bundles
2026-09-11 15:14:51 +05:30

69 lines
3.9 KiB
JSON

{
"module": "omniread.xlsx.client",
"content": {
"path": "omniread.xlsx.client",
"docstring": "# Summary\n\nXLSX client abstractions for OmniRead.\n\nThis module defines the **client layer** responsible for retrieving raw\nOffice Open XML spreadsheet bytes from a concrete backing store.\n\nClients provide low-level access to xlsx binaries and are intentionally\ndecoupled from scraping and parsing logic. They do not perform validation,\ninterpretation, or content extraction.\n\nTypical backing stores include:\n\n- Local filesystems\n- Object storage (S3, GCS, etc.)\n- Network file systems",
"objects": {
"ABC": {
"name": "ABC",
"kind": "alias",
"path": "omniread.xlsx.client.ABC",
"signature": "<bound method Alias.signature of Alias('ABC', 'abc.ABC')>",
"docstring": null
},
"abstractmethod": {
"name": "abstractmethod",
"kind": "alias",
"path": "omniread.xlsx.client.abstractmethod",
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
"docstring": null
},
"Path": {
"name": "Path",
"kind": "alias",
"path": "omniread.xlsx.client.Path",
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
"docstring": null
},
"Any": {
"name": "Any",
"kind": "alias",
"path": "omniread.xlsx.client.Any",
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
"docstring": null
},
"BaseXlsxClient": {
"name": "BaseXlsxClient",
"kind": "class",
"path": "omniread.xlsx.client.BaseXlsxClient",
"signature": "<bound method Class.signature of Class('BaseXlsxClient', 25, 58)>",
"docstring": "Abstract client responsible for retrieving spreadsheet bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full xlsx binary payload.\n - Raise retrieval-specific errors on failure.",
"members": {
"fetch": {
"name": "fetch",
"kind": "function",
"path": "omniread.xlsx.client.BaseXlsxClient.fetch",
"signature": "<bound method Function.signature of Function('fetch', 40, 58)>",
"docstring": "Fetch raw xlsx bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the spreadsheet location, such as a file path,\n object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw xlsx bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
}
}
},
"FileSystemXlsxClient": {
"name": "FileSystemXlsxClient",
"kind": "class",
"path": "omniread.xlsx.client.FileSystemXlsxClient",
"signature": "<bound method Class.signature of Class('FileSystemXlsxClient', 61, 97)>",
"docstring": "XLSX client that reads from the local filesystem.\n\nNotes:\n **Guarantees:**\n\n - This client reads spreadsheet files directly from the disk and\n returns their raw binary contents.",
"members": {
"fetch": {
"name": "fetch",
"kind": "function",
"path": "omniread.xlsx.client.FileSystemXlsxClient.fetch",
"signature": "<bound method Function.signature of Function('fetch', 72, 97)>",
"docstring": "Read an xlsx file from the local filesystem.\n\nArgs:\n path (Path):\n Filesystem path to the spreadsheet file.\n\nReturns:\n bytes:\n Raw xlsx bytes.\n\nRaises:\n FileNotFoundError:\n If the path does not exist.\n ValueError:\n If the path exists but is not a file."
}
}
}
}
}
}