2018-09-26 06:16:02 +02:00
|
|
|
[](https://codecov.io/gh/lbryio/txupnp)
|
|
|
|
|
|
2018-07-30 23:48:20 +02:00
|
|
|
# UPnP for Twisted
|
|
|
|
|
|
2018-10-01 15:51:31 +02:00
|
|
|
`txupnp` is a python 3 library to interact with UPnP gateways using `twisted`
|
2018-07-30 23:48:20 +02:00
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
2018-07-30 23:51:59 +02:00
|
|
|
```
|
2018-08-03 17:51:03 +02:00
|
|
|
pip install --upgrade txupnp
|
2018-07-30 23:51:59 +02:00
|
|
|
```
|
2018-07-30 23:48:20 +02:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2018-07-31 17:35:24 +02:00
|
|
|
```
|
2018-08-03 17:51:03 +02:00
|
|
|
usage: txupnp-cli [-h] [--debug_logging] [--include_igd_xml] command
|
2018-07-30 23:52:16 +02:00
|
|
|
|
2018-07-31 17:35:24 +02:00
|
|
|
positional arguments:
|
2018-08-03 17:53:27 +02:00
|
|
|
command debug_device | list_mappings | get_external_ip |
|
2018-08-03 17:51:03 +02:00
|
|
|
add_mapping | delete_mapping
|
2018-07-30 23:52:16 +02:00
|
|
|
|
2018-07-31 17:35:24 +02:00
|
|
|
optional arguments:
|
2018-08-03 17:51:03 +02:00
|
|
|
-h, --help show this help message and exit
|
2018-07-31 17:35:24 +02:00
|
|
|
--debug_logging
|
2018-08-03 17:51:03 +02:00
|
|
|
--include_igd_xml
|
2018-07-31 17:35:24 +02:00
|
|
|
```
|
2018-07-30 23:48:20 +02:00
|
|
|
|
2018-07-30 23:52:16 +02:00
|
|
|
|
2018-07-30 23:48:20 +02:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
|
|
|
|
|
|
|
|
|
|
## Contact
|
|
|
|
|
|
2018-07-31 17:35:24 +02:00
|
|
|
The primary contact for this project is @jackrobison
|
