| Lott, Christopher (cl778h) | ca170d3 | 2020-05-12 15:05:59 -0400 | [diff] [blame] | 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 | |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 5 | RMR Python Bindings |
| 6 | =================== |
| Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 7 | |
| 8 | Overview |
| 9 | -------- |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 10 | |
| Lott, Christopher (cl778h) | f55e4d8 | 2020-04-10 16:02:11 -0400 | [diff] [blame] | 11 | The xapp python framework package includes a python subpackage called |
| 12 | `rmr`. This subpackage (`ricxappframe.rmr`) is a CTYPES wrapper |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 13 | around the RMR shared library. Most Xapp users will never use this |
| Lott, Christopher (cl778h) | f55e4d8 | 2020-04-10 16:02:11 -0400 | [diff] [blame] | 14 | subpackage natively; however python apps that need access to the |
| 15 | low-level RMR API can use it. |
| Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 16 | |
| Lott, Christopher (cl778h) | f55e4d8 | 2020-04-10 16:02:11 -0400 | [diff] [blame] | 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>` |
| Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 22 | |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 23 | RMR API |
| 24 | ------- |
| Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 25 | |
| Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame] | 26 | .. automodule:: ricxappframe.rmr.rmr |
| 27 | :members: |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 28 | |
| 29 | |
| Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame] | 30 | RMR Helper API |
| 31 | -------------- |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 32 | |
| Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame] | 33 | .. automodule:: ricxappframe.rmr.helpers |
| 34 | :members: |