Go to file
Neels Hofmeyr 3ef39e9b9e osmoutil: centrally log process launches
Log Popen in osmoutil.py instead of in each python test. Launch message is
being removed in openbsc's python tests and added here. (change-id
Id8eb70ddfdc1d0d9f90aa5343a4ea522042c34ee)

Change-Id: I7e539abc3aeee91ae3e7635f9e28b9e557eaf969
2017-02-24 20:49:27 +01:00
osmopy osmoutil: centrally log process launches 2017-02-24 20:49:27 +01:00
.gitignore Add .gitignore 2016-03-31 11:59:09 +02:00
README Expand installation instructions 2016-03-31 11:59:10 +02:00
setup.py Documentation: added a README, more docstrings; +x'd setup.py 2013-04-05 17:08:28 +02:00

README

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 ./'

Use
There are currently 3 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)

Each of these scripts imports a project-specific osmoappdesc.py,
which provides information about the available apps, configs, vty ports, etc.

Run the scripts with osmoappdesc.py in the current directory (preferred)
or with -p <the directory containing osmoappdesc.py>.
Remember that osmoappdesc.py may contain relative paths.

Example:
After install osmodumpdoc for openbsc's apps can be run by:
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

obscvty.py may be of general use. osmoutil.py probably isn't.