snowloader 0.1.0__tar.gz

snowloader-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,80 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: Lint & Type Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: pip install -e ".[all,dev]"
+
+      - name: Ruff check
+        run: ruff check src/ tests/
+
+      - name: Ruff format check
+        run: ruff format --check src/ tests/
+
+      - name: Mypy
+        run: mypy src/snowloader/
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[all,dev]"
+
+      - name: Run unit tests
+        run: pytest tests/unit/ -x --tb=short -q --cov=snowloader --cov-report=term-missing
+
+      - name: Upload coverage
+        if: matrix.python-version == '3.13'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: .coverage
+
+  docs:
+    name: Build Docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: pip install -e ".[docs]"
+
+      - name: Build Sphinx docs
+        run: sphinx-build -b html docs/ docs/_build/html

snowloader-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,52 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build Distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/snowloader
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

snowloader-0.1.0/.gitignore

@@ -0,0 +1,28 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+.env
+.venv/
+venv/
+*.log
+.DS_Store
+
+# Documentation build output
+docs/_build/
+
+# Project management files (internal use only)
+CLAUDE.md
+.claude/
+.status
+GETTING_STARTED.md
+docs/tasks/

snowloader-0.1.0/.readthedocs.yaml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.13"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

snowloader-0.1.0/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+All notable changes to snowloader are documented here. This project follows [Semantic Versioning](https://semver.org/).
+
+## [0.1.0] - 2026-03-25
+
+### Added
+
+**Loaders:**
+- `IncidentLoader` — IT incidents with structured text and journal support
+- `KnowledgeBaseLoader` — KB articles with built-in HTML cleaning
+- `CMDBLoader` — Configuration Items with concurrent relationship traversal
+- `ChangeLoader` — Change requests with implementation window details
+- `ProblemLoader` — Problems with root cause and known error handling
+- `CatalogLoader` — Service catalog items
+
+**Framework Adapters:**
+- LangChain adapter (6 classes implementing `BaseLoader`)
+- LlamaIndex adapter (6 classes implementing `BaseReader`)
+
+**Connection:**
+- 4 authentication modes: Basic, OAuth Password Grant, OAuth Client Credentials, Bearer Token
+- Automatic pagination with stable ordering (`ORDERBYsys_created_on`)
+- Retry logic with exponential backoff for 429/502/503/504
+- Rate limiting (configurable `request_delay`)
+- Thread-safe HTTP via request lock
+- Proxy and custom CA certificate support
+- Context manager for session lifecycle
+- Configurable timeout, page size, display value mode
+
+**Core Features:**
+- Delta sync via `load_since(datetime)`
+- Memory-efficient streaming via generator-based `lazy_load()`
+- Built-in HTML cleaner (zero external dependencies)
+- Journal entry support (work notes and comments)
+- `SnowDocument` as framework-agnostic intermediate format
+- PEP 561 `py.typed` marker for type checker support
+
+**Testing:**
+- 124 unit tests with mocked HTTP
+- 33 live integration tests against a real ServiceNow instance
+- Full quality gate: ruff, mypy --strict, pytest
+
+[0.1.0]: https://github.com/ronidas39/snowloader/releases/tag/v0.1.0

snowloader-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Roni Das
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

snowloader-0.1.0/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: snowloader
+Version: 0.1.0
+Summary: Comprehensive ServiceNow data loader for AI/LLM pipelines — Incidents, CMDB, KB, Changes, Catalog & more. Works with LangChain & LlamaIndex.
+Project-URL: Homepage, https://github.com/ronidas39/snowloader
+Project-URL: Documentation, https://snowloader.readthedocs.io
+Project-URL: Repository, https://github.com/ronidas39/snowloader
+Project-URL: Issues, https://github.com/ronidas39/snowloader/issues
+Project-URL: Changelog, https://github.com/ronidas39/snowloader/blob/main/CHANGELOG.md
+Author-email: Roni Das <roni@totaltechnologyzone.com>
+License: MIT
+License-File: LICENSE
+Keywords: agentic-ai,ai,cmdb,data-loader,document-loader,incidents,itsm,knowledge-base,langchain,llamaindex,llm,rag,servicenow,vector-database
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: requests>=2.28.0
+Provides-Extra: all
+Requires-Dist: langchain-core>=0.2.0; extra == 'all'
+Requires-Dist: llama-index-core>=0.11.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: responses>=0.23.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Requires-Dist: types-requests>=2.28.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo>=2024.1.0; extra == 'docs'
+Requires-Dist: myst-parser>=3.0.0; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints>=2.0.0; extra == 'docs'
+Requires-Dist: sphinx-copybutton>=0.5.0; extra == 'docs'
+Requires-Dist: sphinx-inline-tabs>=2023.4.0; extra == 'docs'
+Requires-Dist: sphinx>=7.0.0; extra == 'docs'
+Provides-Extra: langchain
+Requires-Dist: langchain-core>=0.2.0; extra == 'langchain'
+Provides-Extra: llamaindex
+Requires-Dist: llama-index-core>=0.11.0; extra == 'llamaindex'
+Description-Content-Type: text/markdown
+
+# snowloader
+
+[![PyPI version](https://img.shields.io/pypi/v/snowloader.svg)](https://pypi.org/project/snowloader/)
+[![Python versions](https://img.shields.io/pypi/pyversions/snowloader.svg)](https://pypi.org/project/snowloader/)
+[![CI](https://github.com/ronidas39/snowloader/actions/workflows/ci.yml/badge.svg)](https://github.com/ronidas39/snowloader/actions/workflows/ci.yml)
+[![Documentation](https://readthedocs.org/projects/snowloader/badge/?version=latest)](https://snowloader.readthedocs.io)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Typed](https://img.shields.io/badge/typing-typed-blue.svg)](https://peps.python.org/pep-0561/)
+
+> Comprehensive ServiceNow data loader for AI/LLM pipelines — Incidents, CMDB, KB, Changes, Problems, Catalog & more.
+
+**Works with LangChain & LlamaIndex out of the box. Python 3.10–3.13.**
+
+**[Documentation](https://snowloader.readthedocs.io)** | **[PyPI](https://pypi.org/project/snowloader/)** | **[GitHub](https://github.com/ronidas39/snowloader)**
+
+---
+
+## Why snowloader?
+
+Building RAG or agentic AI on top of ServiceNow data? You need a reliable way to pull structured ITSM records into your vector store. Existing tools either cover a single table, ignore relationships, or lock you into one framework.
+
+snowloader gives you:
+
+- **6 loaders** covering the core ServiceNow tables (Incidents, Knowledge Base, CMDB, Changes, Problems, Service Catalog)
+- **CMDB relationship traversal** — concurrent graph walking with dependency mapping
+- **Delta sync** — only fetch records updated since your last sync
+- **4 auth modes** — Basic, OAuth Password, OAuth Client Credentials, Bearer Token
+- **Production-grade** — retry with backoff, rate limiting, thread safety, proxy support
+- **Framework-agnostic core** with thin adapters for LangChain and LlamaIndex
+- **Memory-efficient streaming** — generator-based pagination, never holds the full table in memory
+- **Built-in HTML cleaning** — strips KB article HTML without extra dependencies
+- **Fully typed** — PEP 561 compliant, mypy --strict clean
+
+## Installation
+
+```bash
+# pip
+pip install snowloader              # Core only
+pip install snowloader[langchain]   # + LangChain adapter
+pip install snowloader[llamaindex]  # + LlamaIndex adapter
+pip install snowloader[all]         # Everything
+
+# uv
+uv add snowloader
+uv add snowloader[all]
+```
+
+**Requirements:** Python 3.10+ and a ServiceNow instance with REST API access.
+
+## Quick Start
+
+```python
+from snowloader import SnowConnection, IncidentLoader
+
+conn = SnowConnection(
+    instance_url="https://mycompany.service-now.com",
+    username="admin",
+    password="password",
+)
+
+loader = IncidentLoader(connection=conn, query="active=true^priority<=2")
+for doc in loader.lazy_load():
+    print(doc.page_content[:200])
+```
+
+## All 6 Loaders
+
+Every loader shares the same interface: `load()` returns a list, `lazy_load()` yields one document at a time, `load_since(datetime)` fetches only updated records.
+
+```python
+from snowloader import (
+    IncidentLoader,         # IT incidents
+    KnowledgeBaseLoader,    # KB articles (HTML auto-cleaned)
+    CMDBLoader,             # Configuration items + relationships
+    ChangeLoader,           # Change requests
+    ProblemLoader,          # Problem records
+    CatalogLoader,          # Service catalog items
+)
+```
+
+## LangChain Adapter
+
+```python
+from snowloader import SnowConnection
+from snowloader.adapters.langchain import ServiceNowIncidentLoader
+
+conn = SnowConnection(instance_url="...", username="...", password="...")
+loader = ServiceNowIncidentLoader(connection=conn, query="active=true")
+docs = loader.load()  # list[langchain_core.documents.Document]
+
+# Use with any vector store
+from langchain_community.vectorstores import FAISS
+from langchain_openai import OpenAIEmbeddings
+
+vectorstore = FAISS.from_documents(docs, OpenAIEmbeddings())
+```
+
+## LlamaIndex Adapter
+
+```python
+from snowloader.adapters.llamaindex import ServiceNowIncidentReader
+
+reader = ServiceNowIncidentReader(connection=conn, query="active=true")
+docs = reader.load_data()  # list[llama_index.core.schema.Document]
+
+from llama_index.core import VectorStoreIndex
+index = VectorStoreIndex.from_documents(docs)
+```
+
+## Delta Sync
+
+```python
+from datetime import datetime, timezone
+
+loader = IncidentLoader(connection=conn)
+docs = loader.load()                          # First run: everything
+last_sync = datetime.now(timezone.utc)
+
+updated = loader.load_since(last_sync)        # Next runs: only changes
+```
+
+## CMDB Relationship Traversal
+
+```python
+loader = CMDBLoader(
+    connection=conn,
+    ci_class="cmdb_ci_server",
+    include_relationships=True,
+)
+
+for doc in loader.lazy_load():
+    # -> db-prod-01 (Depends on::Used by)
+    # <- load-balancer-01 (Depends on::Used by)
+    print(doc.page_content)
+```
+
+## Authentication
+
+```python
+# Basic Auth (development)
+conn = SnowConnection(instance_url="...", username="admin", password="pass")
+
+# OAuth Client Credentials (recommended for production)
+conn = SnowConnection(instance_url="...", client_id="...", client_secret="...")
+
+# OAuth Password Grant
+conn = SnowConnection(instance_url="...", client_id="...", client_secret="...",
+                       username="...", password="...")
+
+# Bearer Token (pre-obtained)
+conn = SnowConnection(instance_url="...", token="eyJhbG...")
+```
+
+## Configuration
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `page_size` | `100` | Records per API call (1–10,000) |
+| `timeout` | `60` | HTTP timeout in seconds |
+| `max_retries` | `3` | Retry attempts for 429/502/503/504 |
+| `retry_backoff` | `1.0` | Base delay between retries (doubles each attempt) |
+| `request_delay` | `0.0` | Min seconds between requests (rate limiting) |
+| `display_value` | `"true"` | `sysparm_display_value` setting |
+| `proxy` | `None` | HTTP/HTTPS proxy URL |
+| `verify` | `True` | SSL verification (path for custom CA bundle) |
+
+See the [full documentation](https://snowloader.readthedocs.io/en/latest/configuration.html) for all parameters.
+
+## Roadmap
+
+| Version | Feature | Status |
+|---------|---------|--------|
+| **v0.2** | Async support (`aiohttp` + `async for`) — 10-50x faster | Coming soon |
+| **v0.2** | Attachment loader (`sys_attachment` downloads) | Coming soon |
+| **v0.3** | Direct vector store streaming (Pinecone, Weaviate, Chroma) | Planned |
+| **v0.3** | Checkpoint and resume for large loads | Planned |
+| **v1.0** | Custom field mapping for customized instances | Planned |
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Write tests first (we use pytest + responses for HTTP mocking)
+4. Ensure the quality gate passes:
+   ```bash
+   ruff check src/ tests/ && ruff format --check src/ tests/ && mypy src/snowloader/ && pytest tests/ -x
+   ```
+5. Open a pull request
+
+## Author
+
+Created and maintained by **[Roni Das](https://github.com/ronidas39)**.
+
+## License
+
+MIT — see [LICENSE](LICENSE) for details.

snowloader-0.1.0/README.md

@@ -0,0 +1,198 @@
+# snowloader
+
+[![PyPI version](https://img.shields.io/pypi/v/snowloader.svg)](https://pypi.org/project/snowloader/)
+[![Python versions](https://img.shields.io/pypi/pyversions/snowloader.svg)](https://pypi.org/project/snowloader/)
+[![CI](https://github.com/ronidas39/snowloader/actions/workflows/ci.yml/badge.svg)](https://github.com/ronidas39/snowloader/actions/workflows/ci.yml)
+[![Documentation](https://readthedocs.org/projects/snowloader/badge/?version=latest)](https://snowloader.readthedocs.io)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Typed](https://img.shields.io/badge/typing-typed-blue.svg)](https://peps.python.org/pep-0561/)
+
+> Comprehensive ServiceNow data loader for AI/LLM pipelines — Incidents, CMDB, KB, Changes, Problems, Catalog & more.
+
+**Works with LangChain & LlamaIndex out of the box. Python 3.10–3.13.**
+
+**[Documentation](https://snowloader.readthedocs.io)** | **[PyPI](https://pypi.org/project/snowloader/)** | **[GitHub](https://github.com/ronidas39/snowloader)**
+
+---
+
+## Why snowloader?
+
+Building RAG or agentic AI on top of ServiceNow data? You need a reliable way to pull structured ITSM records into your vector store. Existing tools either cover a single table, ignore relationships, or lock you into one framework.
+
+snowloader gives you:
+
+- **6 loaders** covering the core ServiceNow tables (Incidents, Knowledge Base, CMDB, Changes, Problems, Service Catalog)
+- **CMDB relationship traversal** — concurrent graph walking with dependency mapping
+- **Delta sync** — only fetch records updated since your last sync
+- **4 auth modes** — Basic, OAuth Password, OAuth Client Credentials, Bearer Token
+- **Production-grade** — retry with backoff, rate limiting, thread safety, proxy support
+- **Framework-agnostic core** with thin adapters for LangChain and LlamaIndex
+- **Memory-efficient streaming** — generator-based pagination, never holds the full table in memory
+- **Built-in HTML cleaning** — strips KB article HTML without extra dependencies
+- **Fully typed** — PEP 561 compliant, mypy --strict clean
+
+## Installation
+
+```bash
+# pip
+pip install snowloader              # Core only
+pip install snowloader[langchain]   # + LangChain adapter
+pip install snowloader[llamaindex]  # + LlamaIndex adapter
+pip install snowloader[all]         # Everything
+
+# uv
+uv add snowloader
+uv add snowloader[all]
+```
+
+**Requirements:** Python 3.10+ and a ServiceNow instance with REST API access.
+
+## Quick Start
+
+```python
+from snowloader import SnowConnection, IncidentLoader
+
+conn = SnowConnection(
+    instance_url="https://mycompany.service-now.com",
+    username="admin",
+    password="password",
+)
+
+loader = IncidentLoader(connection=conn, query="active=true^priority<=2")
+for doc in loader.lazy_load():
+    print(doc.page_content[:200])
+```
+
+## All 6 Loaders
+
+Every loader shares the same interface: `load()` returns a list, `lazy_load()` yields one document at a time, `load_since(datetime)` fetches only updated records.
+
+```python
+from snowloader import (
+    IncidentLoader,         # IT incidents
+    KnowledgeBaseLoader,    # KB articles (HTML auto-cleaned)
+    CMDBLoader,             # Configuration items + relationships
+    ChangeLoader,           # Change requests
+    ProblemLoader,          # Problem records
+    CatalogLoader,          # Service catalog items
+)
+```
+
+## LangChain Adapter
+
+```python
+from snowloader import SnowConnection
+from snowloader.adapters.langchain import ServiceNowIncidentLoader
+
+conn = SnowConnection(instance_url="...", username="...", password="...")
+loader = ServiceNowIncidentLoader(connection=conn, query="active=true")
+docs = loader.load()  # list[langchain_core.documents.Document]
+
+# Use with any vector store
+from langchain_community.vectorstores import FAISS
+from langchain_openai import OpenAIEmbeddings
+
+vectorstore = FAISS.from_documents(docs, OpenAIEmbeddings())
+```
+
+## LlamaIndex Adapter
+
+```python
+from snowloader.adapters.llamaindex import ServiceNowIncidentReader
+
+reader = ServiceNowIncidentReader(connection=conn, query="active=true")
+docs = reader.load_data()  # list[llama_index.core.schema.Document]
+
+from llama_index.core import VectorStoreIndex
+index = VectorStoreIndex.from_documents(docs)
+```
+
+## Delta Sync
+
+```python
+from datetime import datetime, timezone
+
+loader = IncidentLoader(connection=conn)
+docs = loader.load()                          # First run: everything
+last_sync = datetime.now(timezone.utc)
+
+updated = loader.load_since(last_sync)        # Next runs: only changes
+```
+
+## CMDB Relationship Traversal
+
+```python
+loader = CMDBLoader(
+    connection=conn,
+    ci_class="cmdb_ci_server",
+    include_relationships=True,
+)
+
+for doc in loader.lazy_load():
+    # -> db-prod-01 (Depends on::Used by)
+    # <- load-balancer-01 (Depends on::Used by)
+    print(doc.page_content)
+```
+
+## Authentication
+
+```python
+# Basic Auth (development)
+conn = SnowConnection(instance_url="...", username="admin", password="pass")
+
+# OAuth Client Credentials (recommended for production)
+conn = SnowConnection(instance_url="...", client_id="...", client_secret="...")
+
+# OAuth Password Grant
+conn = SnowConnection(instance_url="...", client_id="...", client_secret="...",
+                       username="...", password="...")
+
+# Bearer Token (pre-obtained)
+conn = SnowConnection(instance_url="...", token="eyJhbG...")
+```
+
+## Configuration
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `page_size` | `100` | Records per API call (1–10,000) |
+| `timeout` | `60` | HTTP timeout in seconds |
+| `max_retries` | `3` | Retry attempts for 429/502/503/504 |
+| `retry_backoff` | `1.0` | Base delay between retries (doubles each attempt) |
+| `request_delay` | `0.0` | Min seconds between requests (rate limiting) |
+| `display_value` | `"true"` | `sysparm_display_value` setting |
+| `proxy` | `None` | HTTP/HTTPS proxy URL |
+| `verify` | `True` | SSL verification (path for custom CA bundle) |
+
+See the [full documentation](https://snowloader.readthedocs.io/en/latest/configuration.html) for all parameters.
+
+## Roadmap
+
+| Version | Feature | Status |
+|---------|---------|--------|
+| **v0.2** | Async support (`aiohttp` + `async for`) — 10-50x faster | Coming soon |
+| **v0.2** | Attachment loader (`sys_attachment` downloads) | Coming soon |
+| **v0.3** | Direct vector store streaming (Pinecone, Weaviate, Chroma) | Planned |
+| **v0.3** | Checkpoint and resume for large loads | Planned |
+| **v1.0** | Custom field mapping for customized instances | Planned |
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Write tests first (we use pytest + responses for HTTP mocking)
+4. Ensure the quality gate passes:
+   ```bash
+   ruff check src/ tests/ && ruff format --check src/ tests/ && mypy src/snowloader/ && pytest tests/ -x
+   ```
+5. Open a pull request
+
+## Author
+
+Created and maintained by **[Roni Das](https://github.com/ronidas39)**.
+
+## License
+
+MIT — see [LICENSE](LICENSE) for details.