SDK for building rApps in BubbleRAN MX-PDK
Project description
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
| 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
- 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
- Set up a virtual environment
cd /path/to/your/rapp-sdk
python3.12 -m venv venv
source venv/bin/activate
- 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file br_rapp_sdk-2026.2.tar.gz.
File metadata
- Download URL: br_rapp_sdk-2026.2.tar.gz
- Upload date:
- Size: 37.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
325fc3f7f3ff2a5ef3f0407981d0c80b1310933fd397bd4ec583943089c6a432
|
|
| MD5 |
4fcbbf1bdbe2d49a5cc0cf9ceab37848
|
|
| BLAKE2b-256 |
044fbecb763683e9e7696d9154fffee4871b8d4126b238457d4a58625f5cdbff
|
File details
Details for the file br_rapp_sdk-2026.2-py3-none-any.whl.
File metadata
- Download URL: br_rapp_sdk-2026.2-py3-none-any.whl
- Upload date:
- Size: 42.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c0cb27ff5f47c1d186f6bd91d7c73152c4947a020f4e984bd10e929d95a02e4c
|
|
| MD5 |
f768cebcd735718f5c9d3565bbcbca50
|
|
| BLAKE2b-256 |
e008c61ff412ef1b80a4b3fe56f6bc2058d501fef3de5ff15839524b6de37870
|