Viewing Documentation for Mininet's Python API

Mininet's modules and Python API are documented using Python documentation strings which may be accessed from Python's regular help() mechanism. For example,

python
>>> from mininet.node import Host
>>> help(Host.IP)
Help on method IP in module mininet.node:
IP(self, intf=None) unbound mininet.node.Host method
        Return IP address of a node or specific interface.

You may also wish to generate HTML documentation using doxypy:

sudo apt-get install doxypy
cd ~/mininet
make doc
python -m SimpleHTTPServer &

At this point, you can point a web browser to port 8000 of the host that Mininet is running on and browse the documentation for each of Mininet's classes.

Additionally, Mininet includes several useful pieces of sample code in mininet/examples.