docs/rmr_api.rst

   1 RMR Python Bindings
   2 ===================
   3
   4 Overview
   5 --------
   6
   7 The xapp python framework package includes a python subpackage called
   8 `rmr`.  This subpackage (`ricxappframe.rmr`) is a CTYPES wrapper
   9 around the RMR shared library.  Most Xapp users will never use this
  10 subpackage natively; however python apps that need access to the
  11 low-level RMR API can use it.
  12
  13 Usage of this python package requires that the RMR shared-object
  14 library is installed in a system library that is included in the
  15 directories found by default, usually something like /usr/local/lib.
  16
  17 The RMR library man pages are available here: :doc:`RMR Man Pages <ric-plt-lib-rmr:index>`
  18
  19 RMR API
  20 -------
  21
  22 .. automodule:: ricxappframe.rmr.rmr
  23     :members:
  24
  25
  26 RMR Helper API
  27 --------------
  28
  29 .. automodule:: ricxappframe.rmr.helpers
  30     :members: