networkmanager/__init__.py

   1 """A library for NetworkManager
   2
   3 User's view: the computer has an IP address and can connect to one of the
   4 WiFi networks around, or to a wire.
   5
   6 Admin's view: the computer has network interfaces (on network devices),
   7 which have configurations (/etc/network...). They can connect to access
   8 points around. A connected interface has an IP config.
   9
  10 NetworkManager's view: computer has L{Devices<Device>}, some of which are
  11 managed by L{NetworkManager}.  WiFi devices see L{APs<AccessPoint>}. There are
  12 L{Connections<networkmanager.applet.Connection>} which specify how a type of
  13 device (wired, wireless) can be activated. The connections are provided by two
  14 services separate from NM: NMSS and NMUS.  To connect, the needed ingredients
  15 are a Connection (+its service), a Device, optionally an L{AccessPoint}. It
  16 results in an L{ActiveConnection} which remembers its ingredients. The device
  17 then knows its L{IP4Config} and L{DHCP4Config}.
  18
  19 (TODO: explain VPN plugins, modems (ModemManager))
  20
  21 For details, see
  22
  23   - U{http://projects.gnome.org/NetworkManager/developers/spec.html}
  24   - U{http://live.gnome.org/NetworkManagerConfigurationSpecification}
  25 """
  26 #__docformat__ = "restructuredtext en"
  27 # TODO hyperlinks to classes in epydoc. a diagram?
  28 from accesspoint import AccessPoint
  29 from activeconnection import ActiveConnection
  30 from device import Device, IP4Config, DHCP4Config
  31 from networkmanager import NetworkManager
  32
  33 __all__ = ["AccessPoint", "ActiveConnection", "Device",
  34            "DHCP4Config", "IP4Config", "NetworkManager", ]