docs/rmr_api.rst

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