Skip to main content

IGD management CLI tool.

Project description

https://travis-ci.org/povilasb/pyigd.svg?branch=master https://coveralls.io/repos/github/povilasb/pyigd/badge.svg?branch=master

This is a small python based tool to interact with IGD capable devices. IGD is protocol, usually supported by routers, that allows you to:

  • Learn the public (external) IP address
  • Enumerate existing port mappings
  • Add and remove port mappings

This tool aims to be simple, clean, easy to install, hackable tool. Hence, CI is enabled, test coverage should be kept to the maximum, code is linted, types are checked, open source liraries are reused, etc.

Sorry, no Python 2 support.

Install

$ pip3 install igd

or if you want to get latest development changes:

$ pip3 install git+https://github.com/povilasb/pyigd

Usage

usage.gif

igd aims for ergonomic usage with convenient defaults but also tries to give full control over how ports are mapped, listed and removed.

For more detailed description just use the –help option for each command:

$igd --help
Usage: igd [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  add  Add new port mapping.
  ip   Get external IP from IGD.
  ls   Get all port mappings.
  rm   Remove port mapping.

Other projects

Other quite usable projects that I found to work:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

igd-0.1.1.tar.gz (7.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page