aioupnp/README.md

31 lines
582 B
Markdown
Raw Normal View History

2018-07-30 23:48:20 +02:00
# UPnP for Twisted
`txupnp` is a python2/3 library to interact with UPnP gateways using Twisted
## Installation
2018-07-30 23:51:59 +02:00
```
git clone https://github.com/lbryio/txupnp.git
cd txupnp
pip install -e .
```
2018-07-30 23:48:20 +02:00
## Usage
2018-07-30 23:51:14 +02:00
`txupnp-cli --help`
2018-07-30 23:52:16 +02:00
2018-07-30 23:52:32 +02:00
`txupnp-cli --command=debug` to get gateway debugging information
2018-07-30 23:52:16 +02:00
2018-07-30 23:51:14 +02:00
`txupnp-cli --command=list_mappings` to show redirects
2018-07-30 23:52:16 +02:00
2018-07-30 23:51:14 +02:00
`txupnp-cli --debug` to turn on very verbose logging
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
The primary contact for this project is @jackrobison(jackrobison@lbry.io)