skip to navigation
skip to content

Not Logged In

pif 0.7

Public IP address checker.

Package Documentation

Latest Version: 0.7.1

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

Installation
==================================
Install with latest stable version from PyPI

.. code-block:: none

$ pip install pif

or install the latest stable version from source

.. code-block:: none

$ pip install -e hg+https://bitbucket.org/barseghyanartur/pif@stable#egg=pif

or install into python path

.. code-block:: none

$ python setup.py install

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

Usage and examples
==================================
Basic usage
----------------------------------
Get public IP

.. code-block:: python

from pif import get_public_ip
get_public_ip()

Get public IP using preferred checker

.. code-block:: python

get_public_ip('whatismyip.com')

List available checkers

.. code-block:: python

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.

.. code-block:: python

from pif.base import BaseIPChecker, registry

class MyPublicIPChecker(BaseIPChecker):
uid = 'mypublicipchecker' # UID of the checker

def get_public_ip(self):
# Implement your logic

registry.register(MyPublicIPChecker) # Register the checker

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

Command line usage
----------------------------------
It's possible to get your public IP address from command line using the `pif.commands.get_public_ip`
module.

.. code-block:: none

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)

.. code-block:: none

$ get-public-ip

:Example: (with preferred checked and verbose output)

.. code-block:: none

$ get-public-ip -c whatismyip.com -v 1

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>  
File Type Py Version Uploaded on Size
pif-0.7.tar.gz (md5) Source 2014-05-09 22KB
  • Downloads (All Versions):
  • 16 downloads in the last day
  • 117 downloads in the last week
  • 178 downloads in the last month