snowloader 0.1.0__py3-none-any.whl

snowloader/__init__.py

@@ -0,0 +1,36 @@
+"""snowloader -- Comprehensive ServiceNow data loader for AI/LLM pipelines.
+
+Provides a clean, Pythonic interface for pulling data out of ServiceNow tables
+and converting it into document formats that LangChain, LlamaIndex, and other
+LLM frameworks can work with directly. Built for production use with proper
+pagination, delta sync, and memory-efficient streaming.
+
+Author: Roni Das
+"""
+
+from __future__ import annotations
+
+from snowloader.connection import SnowConnection, SnowConnectionError
+from snowloader.loaders.catalog import CatalogLoader
+from snowloader.loaders.changes import ChangeLoader
+from snowloader.loaders.cmdb import CMDBLoader
+from snowloader.loaders.incidents import IncidentLoader
+from snowloader.loaders.knowledge_base import KnowledgeBaseLoader
+from snowloader.loaders.problems import ProblemLoader
+from snowloader.models import BaseSnowLoader, SnowDocument
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "BaseSnowLoader",
+    "CatalogLoader",
+    "ChangeLoader",
+    "CMDBLoader",
+    "IncidentLoader",
+    "KnowledgeBaseLoader",
+    "ProblemLoader",
+    "SnowConnection",
+    "SnowConnectionError",
+    "SnowDocument",
+    "__version__",
+]

snowloader/adapters/__init__.py

@@ -0,0 +1,16 @@
+"""Framework adapters for snowloader.
+
+Thin wrappers that convert SnowDocument output from the core loaders into
+document types expected by LangChain, LlamaIndex, or other LLM frameworks.
+No business logic lives here. If you are looking for query building,
+pagination, or field mapping, check the loaders package instead.
+
+Import paths (adapters are not auto-imported to avoid pulling in optional
+dependencies)::
+
+    # LangChain
+    from snowloader.adapters.langchain import ServiceNowIncidentLoader
+
+    # LlamaIndex
+    from snowloader.adapters.llamaindex import ServiceNowIncidentReader
+"""

snowloader/adapters/langchain.py

@@ -0,0 +1,110 @@
+"""LangChain adapter for snowloader.
+
+Thin wrappers that expose snowloader's core loaders through the standard
+langchain_core BaseLoader interface. Each adapter delegates all the real
+work to the underlying loader and just handles the conversion from
+SnowDocument to langchain_core Document.
+
+No business logic here. If you need to change how documents are built,
+modify the core loaders instead.
+
+Author: Roni Das
+"""
+
+from __future__ import annotations
+
+import logging
+from collections.abc import Iterator
+from datetime import datetime
+from typing import Any
+
+try:
+    from langchain_core.document_loaders import BaseLoader
+    from langchain_core.documents import Document
+except ImportError as exc:
+    raise ImportError(
+        "langchain-core is required for the LangChain adapter. "
+        "Install it with: pip install snowloader[langchain]"
+    ) from exc
+
+from snowloader.connection import SnowConnection
+from snowloader.loaders.catalog import CatalogLoader
+from snowloader.loaders.changes import ChangeLoader
+from snowloader.loaders.cmdb import CMDBLoader
+from snowloader.loaders.incidents import IncidentLoader
+from snowloader.loaders.knowledge_base import KnowledgeBaseLoader
+from snowloader.loaders.problems import ProblemLoader
+from snowloader.models import BaseSnowLoader
+
+logger = logging.getLogger(__name__)
+
+
+class _LangChainAdapter(BaseLoader):
+    """Base adapter that wraps any snowloader loader for LangChain.
+
+    Converts SnowDocument instances to LangChain Document objects.
+    Subclasses just set the _loader_class attribute.
+    """
+
+    _loader_class: type[BaseSnowLoader]
+
+    def __init__(self, connection: SnowConnection, **kwargs: Any) -> None:
+        self._loader = self._loader_class(connection=connection, **kwargs)
+
+    def lazy_load(self) -> Iterator[Document]:
+        """Yield LangChain Documents one at a time from the core loader."""
+        for snow_doc in self._loader.lazy_load():
+            yield Document(
+                page_content=snow_doc.page_content,
+                metadata=snow_doc.metadata,
+            )
+
+    def load_since(self, since: datetime) -> list[Document]:
+        """Fetch only records updated after the given datetime.
+
+        Args:
+            since: Cutoff datetime for delta sync.
+
+        Returns:
+            List of LangChain Document instances.
+        """
+        return [
+            Document(page_content=d.page_content, metadata=d.metadata)
+            for d in self._loader.load_since(since)
+        ]
+
+
+class ServiceNowIncidentLoader(_LangChainAdapter):
+    """LangChain loader for ServiceNow incidents."""
+
+    _loader_class = IncidentLoader
+
+
+class ServiceNowKBLoader(_LangChainAdapter):
+    """LangChain loader for ServiceNow Knowledge Base articles."""
+
+    _loader_class = KnowledgeBaseLoader
+
+
+class ServiceNowCMDBLoader(_LangChainAdapter):
+    """LangChain loader for ServiceNow CMDB configuration items."""
+
+    _loader_class = CMDBLoader
+
+
+class ServiceNowChangeLoader(_LangChainAdapter):
+    """LangChain loader for ServiceNow change requests."""
+
+    _loader_class = ChangeLoader
+
+
+class ServiceNowProblemLoader(_LangChainAdapter):
+    """LangChain loader for ServiceNow problem records."""
+
+    _loader_class = ProblemLoader
+
+
+class ServiceNowCatalogLoader(_LangChainAdapter):
+    """LangChain loader for ServiceNow service catalog items."""
+
+    _loader_class = CatalogLoader

snowloader/adapters/llamaindex.py

@@ -0,0 +1,127 @@
+"""LlamaIndex adapter for snowloader.
+
+Thin wrappers that expose snowloader's core loaders through the standard
+llama_index BaseReader interface. Each adapter delegates all the real
+work to the underlying loader and just handles the conversion from
+SnowDocument to llama_index Document.
+
+No business logic here. If you need to change how documents are built,
+modify the core loaders instead.
+
+Author: Roni Das
+"""
+
+from __future__ import annotations
+
+import logging
+from datetime import datetime
+from typing import Any
+
+try:
+    from llama_index.core.readers.base import BaseReader
+    from llama_index.core.schema import Document
+except ImportError as exc:
+    raise ImportError(
+        "llama-index-core is required for the LlamaIndex adapter. "
+        "Install it with: pip install snowloader[llamaindex]"
+    ) from exc
+
+from snowloader.connection import SnowConnection
+from snowloader.loaders.catalog import CatalogLoader
+from snowloader.loaders.changes import ChangeLoader
+from snowloader.loaders.cmdb import CMDBLoader
+from snowloader.loaders.incidents import IncidentLoader
+from snowloader.loaders.knowledge_base import KnowledgeBaseLoader
+from snowloader.loaders.problems import ProblemLoader
+from snowloader.models import BaseSnowLoader, SnowDocument
+
+logger = logging.getLogger(__name__)
+
+
+class _LlamaIndexAdapter(BaseReader):
+    """Base adapter that wraps any snowloader loader for LlamaIndex.
+
+    Converts SnowDocument instances to LlamaIndex Document objects.
+    Subclasses just set the _loader_class attribute.
+    """
+
+    _loader_class: type[BaseSnowLoader]
+
+    _default_excluded_llm_keys: list[str] = ["sys_id"]
+
+    def __init__(
+        self,
+        connection: SnowConnection,
+        excluded_llm_metadata_keys: list[str] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        super().__init__()
+        self._excluded_keys = (
+            excluded_llm_metadata_keys
+            if excluded_llm_metadata_keys is not None
+            else self._default_excluded_llm_keys
+        )
+        self._loader = self._loader_class(connection=connection, **kwargs)
+
+    def load_data(self) -> list[Document]:
+        """Return a list of LlamaIndex Documents from the core loader.
+
+        Returns:
+            List of LlamaIndex Document instances.
+        """
+        return [self._to_document(d) for d in self._loader.lazy_load()]
+
+    def load_data_since(self, since: datetime) -> list[Document]:
+        """Fetch only records updated after the given datetime.
+
+        Args:
+            since: Cutoff datetime for delta sync.
+
+        Returns:
+            List of LlamaIndex Document instances.
+        """
+        return [self._to_document(d) for d in self._loader.load_since(since)]
+
+    def _to_document(self, snow_doc: SnowDocument) -> Document:
+        """Convert a SnowDocument to a LlamaIndex Document."""
+        return Document(
+            text=snow_doc.page_content,
+            metadata=snow_doc.metadata,
+            excluded_llm_metadata_keys=self._excluded_keys,
+        )
+
+
+class ServiceNowIncidentReader(_LlamaIndexAdapter):
+    """LlamaIndex reader for ServiceNow incidents."""
+
+    _loader_class = IncidentLoader
+
+
+class ServiceNowKBReader(_LlamaIndexAdapter):
+    """LlamaIndex reader for ServiceNow Knowledge Base articles."""
+
+    _loader_class = KnowledgeBaseLoader
+
+
+class ServiceNowCMDBReader(_LlamaIndexAdapter):
+    """LlamaIndex reader for ServiceNow CMDB configuration items."""
+
+    _loader_class = CMDBLoader
+
+
+class ServiceNowChangeReader(_LlamaIndexAdapter):
+    """LlamaIndex reader for ServiceNow change requests."""
+
+    _loader_class = ChangeLoader
+
+
+class ServiceNowProblemReader(_LlamaIndexAdapter):
+    """LlamaIndex reader for ServiceNow problem records."""
+
+    _loader_class = ProblemLoader
+
+
+class ServiceNowCatalogReader(_LlamaIndexAdapter):
+    """LlamaIndex reader for ServiceNow service catalog items."""
+
+    _loader_class = CatalogLoader