BubbleRAN O-RAN rApp SDK

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
• 📡 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

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

2. Set up a virtual environment

cd /path/to/your/rapp-sdk
python3.12 -m venv venv
source venv/bin/activate

3. 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
• Tutorials and examples