Metadata-Version: 2.0
Name: simpleTR64
Version: 1.0
Summary: An easy to use UPnP TR64 protocol library
Home-page: http://bpannier.github.io/simpletr64/
Author: Benjamin Pannier
Author-email: sourcecode@ka.ro
License: Apache 2.0
Keywords: TR64 protocol network UPnP
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Home Automation
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: Topic :: Software Development :: Libraries
Requires-Dist: requests

Simple TR64 UPnP: A simple way to talk to your UPnP and/or TR64 protocol devices
================================================================================


This library supports the discovery of UPnP devices in the local network and let you execute actions on them if
the device supports them. Also it contains a convenient way to execute TR64 protocol actions on routers or other network
devices which supports TR64.

.. code-block:: python

    >>> results = simpletr64.discover()
    >>> print(results[0])
    LOC: http://192.168.178.1:49000/tr64desc.xml SRV: urn:dslforum-org:device:InternetGatewayDevice:1
    ...
    >>> device = simpletr64.DeviceTR64(hostname=192.168.178.1, port=49000)
    ...
    >>> device.execute("/upnp/control/hosts", "urn:dslforum-org:service:Hosts:1", "GetGenericHostEntry", NewIndex=1)
    {'NewActive': '0', 'NewIPAddress': '192.168.0.23', 'NewMACAddress': '9C:20:7B:E7:FF:5F', 'NewInterfaceType':
        'Ethernet', 'NewHostName': 'Apple-TV', 'NewAddressSource': 'DHCP', 'NewLeaseTimeRemaining': '0'}

or even easier, execute:

.. code-block:: python

    >>> device = DeviceTR64("fritz.box")
    >>> device.setupTR64Device("fritz.box")
    >>> system = System(device)
    >>> print(system.getSystemInfo().manufactureName)
    "AVM"

Also please see the `tools <https://github.com/bpannier/simpletr64/tree/master/simpletr64/tools>`_ which have been
provided with this library, these demonstrates the full functionality.

Features
--------

- Discovery of UPnP devices in the local network
- Gathering of UPnP device information's
- Executing of UPnP actions
- Authentication for username/password or password only
- HTTP(S) proxy support
- Unicode

Installation
------------

To install Simple TR64, simply:

.. code-block:: bash

    $ pip install simpletr64

Documentation
-------------

Please, see the `documentation here <http://bpannier.github.io/simpletr64/>`_


.. :changelog:

Release History
---------------

1.0.0 (2015-12-30)
++++++++++++++++++

* Birth!



