docs/rmr_api.rst

   1 RMR
   2 ====
   3
   4 Overview
   5 --------
   6 The xapp framework repo includes a python submodule called `rmr`.
   7 This package (`ricxappframe.rmr`) is a CTYPES wrapper around the C rmr library.
   8 Most Xapp users will never use this package natively; however python apps that need access to the low level rmr API can use this package.
   9 Usage of this python package requires that you have the c rmr libraries installed.
  10
  11
  12 .. API
  13 .. ---
  14
  15 .. .. automodule:: ricxappframe.rmr.rmr
  16 ..   :members: