| Kat | a8ee6bb | 2013-04-05 17:06:30 +0200 | [diff] [blame] | 1 | Building/installation: |
| 2 | sudo python setup.py install |
| 3 | If you prefer to have it cleanly removable, install checkinstall and run |
| 4 | sudo checkinstall python setup.py install |
| 5 | |
| 6 | Use |
| 7 | There are currently 3 scripts in this package: |
| 8 | osmodumpdoc.py - dump documentation (the VTY's "show online-help"). |
| 9 | osmotestconfig.py - test that apps start/write with example configs |
| 10 | osmotestvty.py - test vty operations (currently, tests very few) |
| 11 | |
| 12 | Each of these scripts imports a project-specific osmoappdesc.py, |
| 13 | which provides information about the available apps, configs, vty ports, etc. |
| 14 | |
| 15 | Run the scripts with osmoappdesc.py in the current directory (preferred) |
| 16 | or with -p <the directory containing osmoappdesc.py>. |
| 17 | Remember that osmoappdesc.py may contain relative paths. |
| 18 | |
| 19 | Example: |
| 20 | After install osmodumpdoc for openbsc's apps can be run by: |
| 21 | cd <your_source_dir>/openbsc/openbsc && osmodumpdoc.py |
| 22 | |
| 23 | Libraries: |
| 24 | osmopy/obscvty.py - connect to a vty, run commands on it, see the result |
| 25 | osmopy/osmoutil.py - code that's shared between the scripts |
| 26 | |
| 27 | obscvty.py may be of general use. osmoutil.py probably isn't. |