Go to file
Neels Hofmeyr 066a95dec5 cosmetic: cmdline arg doc tweaks, comment
Change-Id: I60dc059879dfe15cd3415ce1ed068ded28ff084e
2017-10-18 03:57:27 +02:00
osmopy cosmetic: cmdline arg doc tweaks, comment 2017-10-18 03:57:27 +02: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 osmo_verify_*: clarify naming to osmo_interact_* 2017-10-18 03:54:45 +02:00


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

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.

After install osmodumpdoc for openbsc's apps can be run by:
cd <your_source_dir>/openbsc/openbsc && osmodumpdoc.py

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.