Skip to main content

Public IP address checker.

Project description

Discovers your public IP address using pre-defined checkers (external services).

Prerequisites

  • Python 2.7, 3.4, 3.5, PyPy

Installation

Install with latest stable version from PyPI:

pip install pif

or install the latest stable version from source:

pip install https://bitbucket.org/barseghyanartur/pif/get/stable.tar.gz

or install into python path:

python setup.py install

That’s all. See the Usage and examples section for more.

Usage and examples

Basic usage

Get public IP:

from pif import get_public_ip
get_public_ip()

Get public IP using preferred checker:

get_public_ip('v4.ident.me')

List available checkers:

from pif.utils import list_checkers
list_checkers()

Registering a custom IP checker

pif ships with a number of pre-defined public IP checkers. But you may extend it by defining your own ones as follows.

from pif.base import BaseIPChecker, registry

class MyPublicIPChecker(BaseIPChecker):

    uid = 'mypublicipchecker' # UID of the checker

    def get_public_ip(self):
        # TODO: Implement your logic


# Register the checker
registry.register(MyPublicIPChecker)

# Get public IP using the preferred checker
get_public_ip('mypublicipchecker')

Command line usage

It’s possible to get your public IP address from command line using the pif.commands.get_public_ip module.

optional arguments:
  -h, --help            show this help message and exit
  -c PREFERRED_CHECKER, --checker PREFERRED_CHECKER
                        `preferred_checker` value
  -v VERBOSE, --verbose VERBOSE
                    `verbose` value
Example:

(simple)

get-public-ip
Example:

(with preferred checked and verbose output)

get-public-ip -c v4.ident.me -v 1

Testing

Simply type:

./runtests.py

or use tox:

tox

or use tox to check specific env:

tox -e py35

License

GPL 2.0/LGPL 2.1

Support

For any issues contact me at the e-mail given in the Author section.

Author

Artur Barseghyan <artur.barseghyan@gmail.com>

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

pif-0.8.2.tar.gz (21.1 kB view details)

Uploaded Source

Built Distribution

pif-0.8.2-py2.py3-none-any.whl (19.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pif-0.8.2.tar.gz.

File metadata

  • Download URL: pif-0.8.2.tar.gz
  • Upload date:
  • Size: 21.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pif-0.8.2.tar.gz
Algorithm Hash digest
SHA256 5ee4a13a52a6facefb510c4740a28bc33f16ae7fe3b2cc523080102dfddf5bbb
MD5 7349c994f8601ab3796d26900fd845dc
BLAKE2b-256 be9277fec5e8eded1e3c53d43e36a0a8c5463cdaa4af991c65e4dc6cc14a2fb4

See more details on using hashes here.

File details

Details for the file pif-0.8.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pif-0.8.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 dbd3a5032ed8417780d3632e226ea67438751939adbb95e90f471a4565fe95fb
MD5 e4f3a34146f032f313992228fdbffdd7
BLAKE2b-256 204211a03f86acb097f2a1ec329524eecae806cc76ed9fe496bd127e198d895a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page