tilt-py 0.1.0

Python client for processing and sending data to Tilt's distributed computing platform

Tilt Python Client

This is the official Python client for submitting and processing data in the Tilt distributed computing platform.

🚀 Overview

Tilt enables distributed data processing by orchestrating multiple devices connected to a network.
This client is responsible for reading input files, batching the content, and sending it to the Tilt API asynchronously.

📁 Project Structure

.
├── README.md
├── init.py
├── connection.py
├── options.py
├── pyproject.toml
├── requirements.txt
├── tilt.py
└── utils.py

• tilt.py: Main interface class (Tilt) used to run jobs.
• connection.py: Handles file reading and async communication with the API.
• options.py: Manages client configuration and local validation logic.
• utils.py: Utility functions such as logging.
• __init__.py: Exposes the public API (Tilt, Options).

📦 Installation

You can install the library directly from Git using SSH:

pip install "git+ssh://[e-mail]:tilt-network/tilt_py.git@dev"

⚠️ Make sure your SSH key is added to your GitHub account.

🧑‍💻 Usage

from tilt import Tilt, Options

program_id = ''
data_src = ''
options = Options('your_api_key')
"""
Instantiate Tilt object and run it
"""
tilt = Tilt(data_src, program_id, options)
tilt.run()

"""
Poll API to check task status
"""
poll = TaskStatusPolling(program_id, interval=15)
poll.start()
while poll.is_running:
    poll_status = poll.check_status()  # will keep checking the API every <interval> seconds (default is 15 seconds)
    print(poll_status)

poll.stop()

"""
Check status via data streaming
"""
stream = TaskStatusStreaming(program_id)
result = stream.start()  # will keep a connection open and await a response

"""
Fetch processed data after process
"""
data = ProcessedData(program_id, "/tmp/output.bin")
data.download()  # Automatically writes to file

data = ProcessedData(program_id)
content = data.download()  # Returns bytes

The client will read from the configured data source, batch the input, and send it to the configured Tilt API endpoint.

✅ Requirements

• Python 3.8+
• A file-based dataset as input (must be a valid UTF-8 text file)
• Valid API key (can be passed via Options or via TILT_API_KEY environment variable)
• SQLite database at ~/tilt/tilt.db with a programs(name TEXT, program_id TEXT) table for validation