| 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 |
| Max | e732c2c | 2017-11-23 16:42:59 +0100 | [diff] [blame] | 5 | Alternatively, just run 'pip install --user -e ./' or 'pip3 install --user -e ./' |
| 6 | depending on your python version. |
| Kat | a8ee6bb | 2013-04-05 17:06:30 +0200 | [diff] [blame] | 7 | |
| 8 | Use |
| Max | e732c2c | 2017-11-23 16:42:59 +0100 | [diff] [blame] | 9 | There are currently following scripts in this package: |
| Kat | a8ee6bb | 2013-04-05 17:06:30 +0200 | [diff] [blame] | 10 | osmotestconfig.py - test that apps start/write with example configs |
| Max | e732c2c | 2017-11-23 16:42:59 +0100 | [diff] [blame] | 11 | soap.py - implementation of SOAP <-> Ctrl proxy implemented on top of Twisted |
| Neels Hofmeyr | e5731e0 | 2017-12-19 14:48:29 +0100 | [diff] [blame] | 12 | osmo_interact_vty.py - pipe stdin/stdout to a VTY session |
| 13 | osmo_interact_ctrl.py - pipe stdin/stdout to a CTRL port |
| 14 | osmo_verify_transcript_vty.py - VTY testing by VTY session screen dumps |
| 15 | osmo_verify_transcript_ctrl.py - CTRL testing by CTRL session script files |
| Neels Hofmeyr | 4c283e4 | 2017-12-19 14:49:13 +0100 | [diff] [blame^] | 16 | twisted_ipa.py - implementation of IPA and Ctrl protocols on top of Twisted framework |
| Neels Hofmeyr | e5731e0 | 2017-12-19 14:48:29 +0100 | [diff] [blame] | 17 | osmodumpdoc.py - dump documentation, superseded by osmo_interact_vty.py -X |
| 18 | osmotestvty.py - test vty operations, superseded by osmo_verify_transcript_vty.py |
| Kat | a8ee6bb | 2013-04-05 17:06:30 +0200 | [diff] [blame] | 19 | |
| 20 | Each of these scripts imports a project-specific osmoappdesc.py, |
| 21 | which provides information about the available apps, configs, vty ports, etc. |
| 22 | |
| 23 | Run the scripts with osmoappdesc.py in the current directory (preferred) |
| 24 | or with -p <the directory containing osmoappdesc.py>. |
| 25 | Remember that osmoappdesc.py may contain relative paths. |
| 26 | |
| 27 | Example: |
| 28 | After install osmodumpdoc for openbsc's apps can be run by: |
| 29 | cd <your_source_dir>/openbsc/openbsc && osmodumpdoc.py |
| 30 | |
| 31 | Libraries: |
| Kat | a8ee6bb | 2013-04-05 17:06:30 +0200 | [diff] [blame] | 32 | osmopy/osmoutil.py - code that's shared between the scripts |
| Max | e732c2c | 2017-11-23 16:42:59 +0100 | [diff] [blame] | 33 | osmopy/osmo_ipa.py - generic implementation of IPA and Ctrl protocols in python |
| Neels Hofmeyr | e5731e0 | 2017-12-19 14:48:29 +0100 | [diff] [blame] | 34 | osmopy/osmo_interact/{vty,ctrl}.py - general interactions with VTY and CTRL ports |
| 35 | osmopy/obscvty.py - connect to a vty, superseded by osmo_interact/vty |
| Kat | a8ee6bb | 2013-04-05 17:06:30 +0200 | [diff] [blame] | 36 | |
| 37 | obscvty.py may be of general use. osmoutil.py probably isn't. |