outray 0.0.1

Python SDK for outray.dev tunneling service

# Outray

`outray` is a Python library for creating **HTTP, TCP, and UDP tunnels** using (https://outray.dev/)[https://outray.dev/]. It allows you to forward local services to a remote endpoint easily.  

Install via pip:

```bash
pip install outray

---

Features

• HTTP tunnel proxy (HttpListener)
• TCP tunnel proxy (TCPListener)
• UDP tunnel proxy (UDPListener)
• Forward a tunnel asynchronously or synchronously
• Built-in error handling and logging

---

Usage Example

• Asynchronous

import asyncio
from outray import forward, http

async def main():
    listener = http("http://localhost:8080")
    await forward(listener)

asyncio.run(main())

• Synchronous

import asyncio
from outray import forward, http

listener = http("http://localhost:8080")
forward_sync(listener)

---

API

Creating a Listener

TCP

from outray import tcp

listener = tcp(local_host="localhost", local_port=8090, remote_port=20710)

UDP

from outray import udp

listener = udp(local_host="localhost", local_port=9000, remote_port=30710)

HTTP

from outray import http

listener = http(url="http://localhost:8080", subdomain="my-subdomain")

---

Forwarding a Tunnel

Asynchronous (forward)

from outray import forward
import asyncio

asyncio.run(forward(listener))

• forward(listener, ws_url=None, force_takeover=None, ping_interval=20, ping_timeout=20, api_key=None)
• Forwards the listener to the remote WebSocket tunnel.
• Handles reconnects automatically.

Synchronous (forward_sync)

from outray import forward_sync

forward_sync(listener)

• Same as forward but runs in a blocking synchronous context.
• Useful for scripts that do not use asyncio natively.

---

Logging

outray uses the standard Python logging module. To see detailed tunnel events:

import logging

logger = logging.getLogger("outray")
logger.setLevel(logging.DEBUG)