ipaddresses
===========

Shows your private and public IP addresses.

Description and features
------------------------

**Description**

Shows your private and public IP addresses.

Although the code is OS independent, I'm only able to test it in console (Windows Cmd) and Windows GUI.

**Features:**

* Shows the private and public IP addresses.

Installation, usage and options
-------------------------------

**Installation**

.. code:: bash

    $ pip install ipaddresses

**Usage**

.. code:: bash

    $ ipaddresses

**Options**

.. code:: bash

    $ ipaddresses -h
	
    usage: ipaddresses [-option]

    optional arguments:
	  -g, --gui             start GUI (Graphical User Interface)
	  -h, --help            show help message
	  -l, --license         show license
	  -p, --pause           pause after showing IP addresses
	  -V, --version         show version

    No arguments shows private and public IP addresses.

Resources and contributing
--------------------------

**Resources**

* `Repository <https://github.com/jcrmatos/ipaddresses>`_

**Contributing**

1. Fork the `repository`_ on GitHub.
2. Make a branch of master and commit your changes to it.
3. Ensure that your name is added to the end of the AUTHORS.rst file using the format:
   ``Name <email@domain.com>``
4. Submit a Pull Request to the master branch on GitHub.

.. _repository: https://github.com/jcrmatos/ipaddresses

Copyright 2009-2015 Joao Carlos Roseta Matos. Licensed under the GNU General Public License v2 or later (GPLv2+).
