Skip to main content

SDK for building rApps and AI Agents in BubbleRAN MX-PDK and MX-AI

Project description

BubbleRAN O-RAN rApp SDK

O-RAN Compatible License

The BubbleRAN rApp SDK is a Python-based software development kit designed to simplify the development, deployment, and integration of rApps (non-real-time applications) for the O-RAN RIC within the BubbleRAN architecture. This repository includes both the SDK framework (BubbleRAN Software License) and rApp (Apache 2.0 + Addendum).

Key Features

  • 🛠️ Easy-to-use Python SDK for developing rApps and AI Agents
  • 🔗 Integrates the LangGraph library with the A2A SDK for building AI Agents beyond POCs (ready for production)
  • 📡 Supports O-RAN R1 interface in the K8s Custom Resource Definition (CRD) format
  • ⚙️ Tools to communicate with BubbleRAN orchestration services
  • ☁️ Cloud-native deployment with BubbleRAN MX-ORS, MX-PDK, and MX-AI products

Directory Structure

rapp_sdk/
├── LICENSE              # Apache 2.0 with SDK Addendum
├── CONTRIBUTING.md      # Contribution guidelines
├── README.md            # Revised documentation
├── docs/
├── examples/            # rApp examples and template for rApp lifecycle management (LCM) 
└── src/

License Structure

Software License
rApp SDK BubbleRAN Software License
BubbleRAN rApps Apache 2.0 + Addendum
3rd Party rApps Apache 2.0 + Addendum
Documentation CC-BY-4.0 Guides, specifications, and examples

Important: When building rApps using this SDK, your application code can use Apache 2.0 + Addendum, but must agree with the rApp SDK License.

Installation

  1. Install common dependencies in Ubuntu: (at least python3.12)
# Update package lists
sudo apt update
# Install prerequisites
sudo apt install -y software-properties-common build-essential libssl-dev zlib1g-dev \
  libncurses5-dev libncursesw5-dev libreadline-dev libsqlite3-dev libgdbm-dev \
  libdb5.3-dev libbz2-dev libexpat1-dev liblzma-dev tk-dev libffi-dev
# Add the deadsnakes PPA (which provides newer Python versions)
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
# Install Python 3.12
sudo apt install -y python3.12 python3.12-venv python3.12-distutils
  1. Set up a virtual environment
cd /path/to/your/rapp-sdk
python3.12 -m venv venv
source venv/bin/activate
  1. Install the SDK

If installing from source:

pip3 install .

Or, from PyPI:

pip3 install br-rapp-sdk

Documentation

Visit the BubbleRAN Developer Portal and Labs for:

  • API reference
  • rApp -> Non RT RIC -> xApp workflows
  • rApp lifecycle overview
  • A1 Policy models and examples
  • R1 CRD specifications
  • AI Agents development
  • Tutorials and examples

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

br_rapp_sdk-2025.9rc3.tar.gz (47.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

br_rapp_sdk-2025.9rc3-py3-none-any.whl (57.3 kB view details)

Uploaded Python 3

File details

Details for the file br_rapp_sdk-2025.9rc3.tar.gz.

File metadata

  • Download URL: br_rapp_sdk-2025.9rc3.tar.gz
  • Upload date:
  • Size: 47.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for br_rapp_sdk-2025.9rc3.tar.gz
Algorithm Hash digest
SHA256 b2fd01410da47976d4f8bfec0d902a017f426906cc9235c295476dd67baeb5c5
MD5 6d03d04d3f12320e7b72a62f45bab46c
BLAKE2b-256 6960ebdeae3e4da02d950cad21f198b659f9507c829880833197892d88fe7240

See more details on using hashes here.

File details

Details for the file br_rapp_sdk-2025.9rc3-py3-none-any.whl.

File metadata

File hashes

Hashes for br_rapp_sdk-2025.9rc3-py3-none-any.whl
Algorithm Hash digest
SHA256 ebd3016eafed11f1871455917d745028bab569f8368e2831224483db7c03990a
MD5 50268d0ed0ec6a9bb87b2cfc25762f2d
BLAKE2b-256 3330b98ed632126e825bd4523f85be0ceba727a2f3415c7553f7aa292085a5f0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page