Skip to main content

Railengine Ingestion SDK

Python SDK for ingesting data into Railtown AI Railengine - handles embeddings, storage, indexing, and webhook publishing.

Overview

The rail-engine-ingest package provides a Pythonic interface for publishing data to Railengine. It supports async/await patterns, Pydantic model validation, and familiar configuration patterns.

Installation

uv pip install rail-engine-ingest

Quick Start

# Copy your ENGINE_TOKEN from https://cndr.railtown.ai Project Settings

import asyncio
import os
from railtown.engine.ingest import RailengineIngest
import base64
import json

engine_token = os.getenv("ENGINE_TOKEN")

async def main():
    # Initialize client
    async with RailengineIngest(engine_token=engine_token) as client:
        # Ingest data
        data = {
            "name": "Chicken Shawarma",
            "meal": "lunch",
            "calories": 95
        }
        response = await client.upsert(data)
        print(f"Status: {response.status_code}")

asyncio.run(main())

Configuration

Environment Variable

  • ENGINE_TOKEN - Base64-encoded JSON string containing ingestion credentials

Constructor Parameters

  • engine_token (optional) - ENGINE_TOKEN string (if not provided, reads from env)
  • model (optional) - Pydantic model type for validating ingested data

Features

  • Single upsert() method - Unified interface for ingesting data
  • Multiple data formats - Accepts Pydantic models, dictionaries, or JSON strings
  • Model validation - Optional Pydantic model validation
  • Direct JSON payload - Sends data directly as JSON to the ingestion endpoint
  • Webhook handler - get_webhook_handler() returns a payload parser when the client is constructed with model=
  • Async/await support - Built for modern async Python applications

Error Handling

The SDK provides custom exception classes:

  • RailtownError - Base exception
  • RailtownBadRequestError - 400 Bad Request
  • RailtownUnauthorizedError - 401 Unauthorized
  • RailtownNotFoundError - 404 Not Found
  • RailtownConflictError - 409 Conflict
  • RailtownServerError - 5xx Server errors

Exceptions are raised on errors.

Requirements

  • uv
  • Python 3.11+
  • httpx >= 0.24.0
  • pydantic >= 1.10.0

For retrieving and searching data from Railengine, install and use rail-engine.

License

MIT

Metadata

Release files for rail-engine-ingest 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rail-engine-ingest 0.3.0
File Size Uploaded Provenance
rail_engine_ingest-0.3.0.tar.gz 24.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for rail-engine-ingest 0.3.0
File Interpreter ABI Platform
rail_engine_ingest-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 52.6 kB

Release files / rail_engine_ingest-0.3.0.tar.gz

Download URL rail_engine_ingest-0.3.0.tar.gz
Size 24.9 kB
Tags Source
SHA-256 checksum
How to use checksums
636d7e6a121fd9d4817f6085e8811c46785f4ab6a4580cbf698abdd53098e611
BLAKE2b-256 checksum
How to use checksums
2ec1d8a14f6a2f394fea4b1cf40d922eb5f5654c82bf4bb6e0fe3587b6c723ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / rail_engine_ingest-0.3.0-py3-none-any.whl

Download URL rail_engine_ingest-0.3.0-py3-none-any.whl
Size 27.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cff4bf518be6bf13460181c9b896029726ffbe485da5a1ec58984a5773aedf5d
BLAKE2b-256 checksum
How to use checksums
49b443d8a6f50e864026ce781425a451e074a9ca9c681369f2553ab89379c36b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for rail-engine-ingest 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page