Metadata-Version: 2.1
Name: aioupnp
Version: 0.0.9
Summary: UPnP for asyncio
Home-page: https://github.com/lbryio/aioupnp
Author: Jack Robison
Author-email: jackrobison@lbry.io
License: MIT
Description: [![Build Status](https://travis-ci.org/lbryio/aioupnp.svg?branch=master)](https://travis-ci.org/lbryio/aioupnp)
        [![codecov](https://codecov.io/gh/lbryio/aioupnp/branch/master/graph/badge.svg)](https://codecov.io/gh/lbryio/aioupnp)
        [![PyPI version](https://badge.fury.io/py/aioupnp.svg)](https://badge.fury.io/py/aioupnp)
        [![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/)
        [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)
        
        # UPnP for asyncio
        
        `aioupnp` is a python 3.6/7 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
        
            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](LICENSE).
        
        ## Contact
        
        The primary contact for this project is [@jackrobison](mailto:jack@lbry.io)
        
Keywords: upnp asyncio
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: test
