UPnPy
Lightweight UPnP client library for Python.
Install
$ pip install upnpy
Examples
Get the external IP address of an Internet Gateway Device:
import upnpy
upnp = upnpy.UPnP()
# Discover UPnP devices on the network
# Returns a list of devices e.g.: [Device <Broadcom ADSL Router>]
devices = upnp.discover()
# Select the IGD
# alternatively you can select the device directly from the list
# device = devices[0]
device = upnp.get_igd()
# Get the services available for this device
# Returns a list of services available for the device
# e.g.: [<Service (WANPPPConnection) id="WANPPPConnection.1">, ...]
device.get_services()
# We can now access a specific service on the device by its ID
# The IDs for the services in this case contain illegal values so we can't access it by an attribute
# If the service ID didn't contain illegal values we could access it via an attribute like this:
# service = device.WANPPPConnection
# We will access it like a dictionary instead:
service = device['WANPPPConnection.1']
# Get the actions available for the service
# Returns a list of actions for the service:
# [<Action name="SetConnectionType">,
# <Action name="GetConnectionTypeInfo">,
# <Action name="RequestConnection">,
# <Action name="ForceTermination">,
# <Action name="GetStatusInfo">,
# <Action name="GetNATRSIPStatus">,
# <Action name="GetGenericPortMappingEntry">,
# <Action name="GetSpecificPortMappingEntry">,
# <Action name="AddPortMapping">,
# <Action name="DeletePortMapping">,
# <Action name="GetExternalIPAddress">]
service.get_actions()
# Finally, get the external IP address
# Execute the action by its name
# Returns a dictionary: {'NewExternalIPAddress': 'xxx.xxx.xxx.xxx'}
service.GetExternalIPAddress()
Add a new port mapping to an Internet Gateway Device:
import upnpy
upnp = upnpy.UPnP()
# Discover UPnP devices on the network
# Returns a list of devices e.g.: [Device <Broadcom ADSL Router>]
devices = upnp.discover()
# Select the IGD
# alternatively you can select the device directly from the list
# device = devices[0]
device = upnp.get_igd()
# Get the services available for this device
# Returns a list of services available for the device
# e.g.: [<Service (WANPPPConnection) id="WANPPPConnection.1">, ...]
device.get_services()
# We can now access a specific service on the device by its ID
# The IDs for the services in this case contain illegal values so we can't access it by an attribute
# If the service ID didn't contain illegal values we could access it via an attribute like this:
# service = device.WANPPPConnection
# We will access it like a dictionary instead:
service = device['WANPPPConnection.1']
# Get the actions available for the service
# Returns a list of actions for the service:
# [<Action name="SetConnectionType">,
# <Action name="GetConnectionTypeInfo">,
# <Action name="RequestConnection">,
# <Action name="ForceTermination">,
# <Action name="GetStatusInfo">,
# <Action name="GetNATRSIPStatus">,
# <Action name="GetGenericPortMappingEntry">,
# <Action name="GetSpecificPortMappingEntry">,
# <Action name="AddPortMapping">,
# <Action name="DeletePortMapping">,
# <Action name="GetExternalIPAddress">]
service.get_actions()
# The action we are looking for is the "AddPortMapping" action
# Lets see what arguments the action accepts
# Use the get_input_arguments() or get_output_arguments() method of the action
# for a list of input / output arguments.
# Example output of the get_input_arguments method for the "AddPortMapping" action
# Returns a dictionary:
# [
# {
# "name": "NewRemoteHost",
# "data_type": "string",
# "allowed_value_list": []
# },
# {
# "name": "NewExternalPort",
# "data_type": "ui2",
# "allowed_value_list": []
# },
# {
# "name": "NewProtocol",
# "data_type": "string",
# "allowed_value_list": [
# "TCP",
# "UDP"
# ]
# },
# {
# "name": "NewInternalPort",
# "data_type": "ui2",
# "allowed_value_list": []
# },
# {
# "name": "NewInternalClient",
# "data_type": "string",
# "allowed_value_list": []
# },
# {
# "name": "NewEnabled",
# "data_type": "boolean",
# "allowed_value_list": []
# },
# {
# "name": "NewPortMappingDescription",
# "data_type": "string",
# "allowed_value_list": []
# },
# {
# "name": "NewLeaseDuration",
# "data_type": "ui4",
# "allowed_value_list": []
# }
# ]
service.AddPortMapping.get_input_arguments()
# Finally, add the new port mapping to the IGD
# This specific action returns an empty dict: {}
service.AddPortMapping(
NewRemoteHost='',
NewExternalPort=80,
NewProtocol='TCP',
NewInternalPort=8000,
NewInternalClient='192.168.1.3',
NewEnabled=1,
NewPortMappingDescription='Test port mapping entry from UPnPy.',
NewLeaseDuration=0
)
Documentation
Documentation is available at https://upnpy.readthedocs.io/en/latest/
License
This project is licensed under the terms of the MIT License.
Metadata
Release files for UPnPy 1.1.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| UPnPy-1.1.8.tar.gz | 13.4 kB | Without provenance | Details for UPnPy-1.1.8.tar.gz |
Release files / UPnPy-1.1.8.tar.gz
| Download URL | UPnPy-1.1.8.tar.gz |
|---|---|
| Size | 13.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f43acab6271c25d8073d0e8549cd62a349abdd0a8cb9c21d036bea6132eb632e
|
|
BLAKE2b-256 checksum How to use checksums |
8066d4e721ff8766ea3e78730574669f6feeb71e438a8c2d7a62b2c3456a5c12
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.9
|
Security for UPnPy 1.1.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.