Rustic AI API
This module provides the backend server for the Rustic AI framework. It provides the interface for creating and interacting with guilds. The interaction with a guild is supported through a Websocket interface, allowing for real-time communication and updates.
Installing
pip install rusticai-api
Note: It depends on rusticai-core and rusticai-ray.
Running from source
- Install required dependencies:
poetry install --with dev
poetry shell
- Start the server:
# If using an external SQL database, expose RUSTIC_METASTORE to the corresponding url
# For example, if using postgres, export RUSTIC_METASTORE=postgresql+psycopg://user:pwd@localhost:5432
./scripts/dev_server.sh
Server will be available at http://localhost:8880 by default. The API documentation can be accessed at http://localhost:8880/docs.
Running from source with Telemetry
- Install required dependencies:
poetry install --with dev
poetry shell
- Start Zipkin server - requires Docker
sudo chmod 777 scripts/zipkin/data-tmp/
./scripts/zipkin/zipkin_up.sh
- Set the otel env variables -
export OTEL_SERVICE_NAME=GuildCommunicationService
export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT="http://localhost:4318/v1/traces"
export OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
Refer docs for details.
- Start the server -
./scripts/dev_server_with_otel.sh
Traces will be visible in Zipkin UI at http://localhost:9411/zipkin/
Note: To stop the Zipkin server, use ./scripts/zipkin/zipkin_down.sh
To run with all the available rusticai packages, use the poetry environment from the root directory, and prefix commands with api/ — for example, use ./api/scripts/dev_server_with_otel.sh instead of ./scripts/dev_server_with_otel.sh.
1 maintainer
Metadata
1 maintainer
Release files for rusticai-api 1.4.0
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 | |
|---|---|---|---|---|
| rusticai_api-1.4.0.tar.gz | 28.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rusticai_api-1.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 65.7 kB
Release files / rusticai_api-1.4.0.tar.gz
| Download URL | rusticai_api-1.4.0.tar.gz |
|---|---|
| Size | 28.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bd51fb73de71a86f8fae779dbb6bf28592f6dade81c7b451ba10d72684e43142
|
|
BLAKE2b-256 checksum How to use checksums |
ef4e85975c8a3a08529606883e8604726beae8ffa7b23173d605db9b3fd4bf72
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.13.12 Linux/6.17.0-1022-azure
|
Release files / rusticai_api-1.4.0-py3-none-any.whl
| Download URL | rusticai_api-1.4.0-py3-none-any.whl |
|---|---|
| Size | 37.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6d299f54a350c583e125a3e8917b861a3b572124c2350cd45b244b58454e5ef5
|
|
BLAKE2b-256 checksum How to use checksums |
80cd2ed683a82148663748503606a65856e63f3d7df4bb4d96abc2a43e80ef63
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.13.12 Linux/6.17.0-1022-azure
|
Security for rusticai-api 1.4.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.
