Skip to main content
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:

References

Release files for igd 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for igd 0.1.1
File Size Uploaded
igd-0.1.1.tar.gz 7.2 kB Details

Release files / igd-0.1.1.tar.gz

Download URL igd-0.1.1.tar.gz
Size 7.2 kB
Tags Source
SHA-256 checksum
How to use checksums
e0c1bf0f888457dfc3fd26ee9c5d74335f25e42b787acb1c90c6a1f12f174a50
BLAKE2b-256 checksum
How to use checksums
272bbc8245f65e2ed064a96d2f4b5e5b36ae3446d738cd368e941b4e560219dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1 This release

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page