Skip to main content

Install

You can install realtime-client SDK from pypi using

pip install realtime-client

This would install the core realtime-client package. You can read docs to get started.

Usage

You can read the docs to learn more about the SDK.

To deploy your realtime function on Adapt's infra, you can use the realtime deploy CLI.

# functions.py contains your realtime function code
realtime deploy --api-key=<your-api-key> functions.py

Contact us to get an API key and deploy.

Once deployed, you can use the playground in the examples repo to test the deployed code.

Examples

All the examples are available at https://github.com/xAlpha8/realtime-examples repo. To install the package so that all examples run, use

pip install "realtime-client[plugins]"

This will install all the additional libraries that are required for examples to work.

Development Environment

To run the dev environment, do:

docker-compose run --service-ports --rm realtime-runner bash

If the container is not already running, you have to run on container start:

poetry install --only main

Publishing

poetry config pypi-token.pypi your-api-token
poetry build
poetry publish

Metadata

Release files for realtime-client 0.1.146

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

Source distribution (sdist)

Source distribution for realtime-client 0.1.146
File Size Uploaded
realtime_client-0.1.146.tar.gz 43.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for realtime-client 0.1.146
File Interpreter ABI Platform
realtime_client-0.1.146-py3-none-any.whl Python 3 none any Details

Total release size: 109.6 kB

Release files / realtime_client-0.1.146.tar.gz

Download URL realtime_client-0.1.146.tar.gz
Size 43.4 kB
Tags Source
SHA-256 checksum
How to use checksums
06d18dbbf94211af382a43136ed5808427b1bc0c7a642cfd5e721a2f3a56d87b
BLAKE2b-256 checksum
How to use checksums
a758227644beadd71f9081b4102c26550b61f791a88290e1178b7440ed4c4e0c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.12.5 Darwin/23.6.0

Release files / realtime_client-0.1.146-py3-none-any.whl

Download URL realtime_client-0.1.146-py3-none-any.whl
Size 66.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
23bd27bdbf910dca9dce42e56efbbcad345ed78df57f50e322b3eae57f5aa999
BLAKE2b-256 checksum
How to use checksums
727f72332fadebeffaf32b931ea8934579865786aec0adae04f8f72690c4a58b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.12.5 Darwin/23.6.0
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