Documentation: added a README, more docstrings; +x'd setup.py
This commit is contained in:
parent
a7185c6c72
commit
a8ee6bb97b
|
@ -0,0 +1,27 @@
|
|||
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
|
||||
|
||||
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.
|
|
@ -18,8 +18,19 @@
|
|||
#
|
||||
import socket
|
||||
|
||||
"""VTYInteract: interact with an osmocom vty
|
||||
|
||||
Specify a VTY to connect to, and run commands on it.
|
||||
Connections will be reestablished as necessary.
|
||||
Methods: __init__, command, enabled_command, verify, w_verify"""
|
||||
|
||||
|
||||
class VTYInteract(object):
|
||||
"""__init__(self, name, host, port):
|
||||
|
||||
name is the name the vty prints for commands, ie OpenBSC
|
||||
host is the hostname to connect to
|
||||
port is the port to connect on"""
|
||||
def __init__(self, name, host, port):
|
||||
self.name = name
|
||||
self.host = host
|
||||
|
@ -72,6 +83,7 @@ class VTYInteract(object):
|
|||
self.command("enable")
|
||||
|
||||
"""Run a command on the vty"""
|
||||
|
||||
def command(self, request, close=False):
|
||||
return self._common_command(request, close)
|
||||
|
||||
|
|
Loading…
Reference in New Issue