aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMax <msuraev@sysmocom.de>2017-11-23 16:42:59 +0100
committerMax <msuraev@sysmocom.de>2017-11-27 14:07:07 +0000
commite732c2ca3badf9e16cb393efb5c4b2556a43fd0b (patch)
treeb7c68195f0cbbc0f43dc07f019ec4bc353c86a19 /README
parentd05da3e68d10abb3c8a7fadbf09da362f11027e3 (diff)
Add *.py from OsmoBSC
Those are generic enough and can be used as advanced example of uzing CTRL interface from python on top of osmo_ipa. Change-Id: Ic4e1155d3bd546feaabab34a46e354c69058056e
Diffstat (limited to 'README')
-rw-r--r--README8
1 files changed, 6 insertions, 2 deletions
diff --git a/README b/README
index b85f7c9..25be782 100644
--- a/README
+++ b/README
@@ -2,13 +2,15 @@ Building/installation:
sudo python setup.py install
If you prefer to have it cleanly removable, install checkinstall and run
sudo checkinstall python setup.py install
-Alternatively, just run 'pip install --user -e ./'
+Alternatively, just run 'pip install --user -e ./' or 'pip3 install --user -e ./'
+depending on your python version.
Use
-There are currently 3 scripts in this package:
+There are currently following scripts in this package:
osmodumpdoc.py - dump documentation (the VTY's "show online-help").
osmotestconfig.py - test that apps start/write with example configs
osmotestvty.py - test vty operations (currently, tests very few)
+soap.py - implementation of SOAP <-> Ctrl proxy implemented on top of Twisted
Each of these scripts imports a project-specific osmoappdesc.py,
which provides information about the available apps, configs, vty ports, etc.
@@ -24,5 +26,7 @@ cd <your_source_dir>/openbsc/openbsc && osmodumpdoc.py
Libraries:
osmopy/obscvty.py - connect to a vty, run commands on it, see the result
osmopy/osmoutil.py - code that's shared between the scripts
+osmopy/osmo_ipa.py - generic implementation of IPA and Ctrl protocols in python
+twisted_ipa.py - implementation of IPA and Ctrl protocols on top of Twisted framework
obscvty.py may be of general use. osmoutil.py probably isn't.