docs/rmr_api.rst

   1 RMR Python Bindings
   2 ===================
   3
   4 Overview
   5 --------
   6
   7 The xapp python framework repository includes a python submodule
   8 called `rmr`.  This package (`ricxappframe.rmr`) is a CTYPES wrapper
   9 around the RMR shared library.  Most Xapp users will never use this
  10 package natively; however python apps that need access to the low
  11 level RMR API can use this package.  Usage of this python package
  12 requires that you have the RMR shared-object library installed.
  13
  14
  15 RMR API
  16 -------
  17
  18 .. automodule:: ricxappframe.rmr.rmr
  19     :members:
  20
  21
  22 RMR Helper API
  23 --------------
  24
  25 .. automodule:: ricxappframe.rmr.helpers
  26     :members: