| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 1 | RMR Python Bindings |
| 2 | =================== |
| Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 3 | |
| 4 | Overview |
| 5 | -------- |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 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. |
| Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 13 | |
| 14 | |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 15 | RMR API |
| 16 | ------- |
| Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 17 | |
| Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame^] | 18 | .. automodule:: ricxappframe.rmr.rmr |
| 19 | :members: |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 20 | |
| 21 | |
| Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame^] | 22 | RMR Helper API |
| 23 | -------------- |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 24 | |
| Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame^] | 25 | .. automodule:: ricxappframe.rmr.helpers |
| 26 | :members: |