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 withmodel= - Async/await support - Built for modern async Python applications
Error Handling
The SDK provides custom exception classes:
RailtownError- Base exceptionRailtownBadRequestError- 400 Bad RequestRailtownUnauthorizedError- 401 UnauthorizedRailtownNotFoundError- 404 Not FoundRailtownConflictError- 409 ConflictRailtownServerError- 5xx Server errors
Exceptions are raised on errors.
Requirements
- uv
- Python 3.11+
- httpx >= 0.24.0
- pydantic >= 1.10.0
Related package
For retrieving and searching data from Railengine, install and use rail-engine.
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for rail-engine-ingest 0.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| rail_engine_ingest-0.2.3.tar.gz | 23.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rail_engine_ingest-0.2.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 50.3 kB
Release files / rail_engine_ingest-0.2.3.tar.gz
| Download URL | rail_engine_ingest-0.2.3.tar.gz |
|---|---|
| Size | 23.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fa70cb11353ba5b72b9b43bde1dd920c2416e54fc1935ae8866c15814b57ee27
|
|
BLAKE2b-256 checksum How to use checksums |
269e1e735ff072b7ad5108db6388ee98c4315fa8e4f22762fa64d203a4ab71a3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.22
|
Release files / rail_engine_ingest-0.2.3-py3-none-any.whl
| Download URL | rail_engine_ingest-0.2.3-py3-none-any.whl |
|---|---|
| Size | 26.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
97540bfc16fd8d5bbf58201cd996cc39064bbd511543d5af89bc50ed463f1e89
|
|
BLAKE2b-256 checksum How to use checksums |
c08a0db702c0f78e40e9dc01793ca5c5d3a0187d8dd594ba5c42a70957a8881b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.22
|
Security for rail-engine-ingest 0.2.3
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.
