UPnP for asyncio

asyncio dd-wrt miniupnpc python python3 scpd ssdp upnp

Find a file

Jack Robison 383f64b854 Merge pull request #19 from lbryio/python-3.8 python 3.8 support		2019-10-25 16:20:15 -04:00
aioupnp	add tests + coverage	2019-10-25 14:47:43 -04:00
stubs	mypy	2019-05-22 01:56:16 -04:00
tests	test python 3.8 support	2019-10-25 16:13:11 -04:00
.coveragerc	stubs	2019-05-22 00:45:33 -04:00
.gitignore	mypy refactor	2019-05-21 18:16:30 -04:00
.pylintrc	pylint, more mypy refactoring, improve tests	2019-05-22 00:29:23 -04:00
.travis.yml	test python 3.8 support	2019-10-25 16:13:11 -04:00
CHANGELOG.md	refactoring, add protocol tests	2018-10-24 19:16:17 -04:00
LICENSE	bump year in license	2019-10-09 00:27:06 +03:00
mypy.ini	refactoring, add protocol tests	2018-10-24 19:16:17 -04:00
README.md	test python 3.8 support	2019-10-25 16:13:11 -04:00
setup.py	test python 3.8 support	2019-10-25 16:13:11 -04:00
wine_build.sh	pyinstaller	2018-10-18 12:31:36 -04:00

README.md

UPnP for asyncio

aioupnp is a python 3.6-8 library and command line tool to interact with UPnP gateways using asyncio. aioupnp requires the netifaces module.

Supported devices

DD-WRT
miniupnpd
Actiontec GT784WN
D-Link DIR-890L
Cisco CGA4131COM
Linksys WRT1200AC
Netgear Nighthawk X4 AC2350
ASUS RT-N66U

Installation

Verify the default python is python 3.6 or 3.7

python --version

Installation for normal usage

pip install aioupnp

Installation for development

git clone https://github.com/lbryio/aioupnp.git
cd aioupnp
pip install -e .

Usage

aioupnp [-h] [--debug_logging] [--interface=<interface>] [--gateway_address=<gateway_address>]
        [--lan_address=<lan_address>] [--timeout=<timeout>]
        [(--<case sensitive m-search header>=<value>)...]
        command [--<arg name>=<arg>]...

If m-search headers are provided as keyword arguments all of the headers to be used must be provided,
in the order they are to be used. For example:

aioupnp --HOST=239.255.255.250:1900 --MAN=\"ssdp:discover\" --MX=1 --ST=upnp:rootdevice m_search

Commands

add_port_mapping | delete_port_mapping | get_external_ip | get_next_mapping | get_port_mapping_by_index | get_redirects | debug_gateway | generate_test_data | get_specific_port_mapping | m_search

Examples

To get the external ip address from the UPnP gateway

aioupnp get_external_ip

To list the active port mappings on the gateway

aioupnp get_redirects

To debug the default gateway (very verbose)

aioupnp --debug_logging debug_gateway

To debug the gateway discovery

aioupnp --debug_logging m_search

To debug a gateway on a non default network interface

aioupnp --interface=vmnet1 --debug_logging m_search

To debug a gateway on a non default network interface that isn't the router

aioupnp --interface=vmnet1 --gateway_address=192.168.1.106 --debug_logging m_search

License

This project is MIT licensed. For the full license, see LICENSE.

Contact

The primary contact for this project is @jackrobison