Metadata-Version: 2.0
Name: noipy
Version: 1.4.2
Summary: Command line tool for DDNS IP address updating.
Home-page: https://github.com/povieira/noipy
Author: Pablo O Vieira
Author-email: email@povieira.com
License: Apache License, Version 2.0
Keywords: no-ip,dyndns,duckdns,ddns,api
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet :: Name Service (DNS)
Requires-Dist: requests (>=2.0)

noipy: DDNS update tool
=======================

.. image:: https://img.shields.io/pypi/v/noipy.svg?style=flat-square
        :target: https://pypi.python.org/pypi/noipy/

.. image:: https://img.shields.io/pypi/dm/noipy.svg?style=flat-square
        :target: https://pypi.python.org/pypi/noipy/

.. image:: https://img.shields.io/travis/povieira/noipy/master.svg?style=flat-square
        :target: https://travis-ci.org/povieira/noipy

.. image:: https://img.shields.io/coveralls/povieira/noipy/master.svg?style=flat-square
        :target: https://coveralls.io/r/povieira/noipy?branch=master

.. image:: https://landscape.io/github/povieira/noipy/master/landscape.svg?style=flat-square
        :target: https://landscape.io/github/povieira/noipy/master
        :alt: Code Health

.. image:: https://zenodo.org/badge/doi/10.5281/zenodo.13320.svg?style=flat-square
        :target: http://dx.doi.org/10.5281/zenodo.13320

Command line tool to update DDNS hosts IP address via update API. Initially
the tool was designed to update IP address only on No-IP DDNS provider. But
now **noipy** has support for the following DDNS providers:

- `No-IP <http://www.noip.com/integrate/request>`_
- `DuckDNS <https://www.duckdns.org/install.jsp>`_
- `DynDNS <http://dyn.com/support/developers/api/perform-update/>`_


Installation
------------

To install **noipy**, simply:

.. code-block:: bash

    $ pip install noipy

**Note**: **noipy** will also install the `Requests HTTP library <https://github.com/kennethreitz/requests>`_ if you haven't yet.


Usage
-----

Basic usage of **noipy** command line tool:

.. code-block:: bash

    $ noipy -u <your username> -p <your password> -n <your hostname on DDNS provider>
            --provider {generic|noip|dyn|duck}


For `DuckDNS provider <https://www.duckdns.org>`_, the command line would look like this:

.. code-block:: bash

    $ noipy -u <your token> -n <your DuckDNS domain> --provider duck


Or you can just use ``--hostname`` (``-n``) and ``--provider`` arguments if you have
previously  stored login information with ``--store`` option.

.. code-block:: bash

    $ noipy --hostname <your hostname on DDNS provider> --provider {generic|noip|dyn| duck}


You can also specify a custom DDNS URL (thanks to `@jayennis22 <https://github.com/jayennis22>`_):

.. code-block:: bash

    $ noipy --hostname <your hostname on DDNS provider> [--provider  generic]
            --url <custom DDNS URL>


It is also possible to inform an IP address other than the machine's current:

.. code-block:: bash

    $ noipy --hostname <your hostname on DDNS provider> 127.0.0.1


If ``--provider`` option is not informed, **generic** will be used as provider.


For details:

.. code-block:: bash

    $ noipy --help


Storing auth information
------------------------

With ``--store`` option it is possible to store login information. The
information is sotred in ``$HOME/.noipy/`` directory:

.. code-block:: bash

    $ noipy --store --username <your username> --password <your password> \
        --provider {generic|noip|dyn| duck}

Or simply:

.. code-block:: bash

    $ noipy --store --provider {generic|noip|dyn| duck}

And type username and password when required.

**Note:** password is stored simply encoded with
`Base64 <https://en.wikipedia.org/wiki/Base64>`_ method and is not actually
*encrypted*!


Contributing
------------

Improvements & Troubleshooting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you have any enhancement suggestions or find a bug, please:

#. Open an `issue <https://github.com/povieira/noipy/issues>`_
#. `Fork <https://github.com/povieira/noipy/fork>`_ the project
#. Do your magic
#. Please, `PEP8 <https://www.python.org/dev/peps/pep-0008/>`_ and test your code
#. Is everything working? Send a `pull request <https://github.com/povieira/noipy/pulls>`_

Running tests
~~~~~~~~~~~~~

First, install tests dependencies (`tox <http://tox.readthedocs.org/en/latest/>`_
and `flake8 <https://flake8.readthedocs.org/>`_):

.. code-block:: bash

    $ pip install -r dev-requirements.txt


To test against all supported Python versions (if you have them installed):

.. code-block:: bash

    $ tox


Or you can to test against a specific version:

.. code-block:: bash

    $ tox -e {version}

Where ``{version}`` can be ``py26``, ``py27``, ``py33``, ``py34``, ``pypy`` and ``pypy3``.


Don't forget to run ``pep8``:

.. code-block:: bash

    $ tox -e pep8


Copyright & License
-------------------

.. image:: https://img.shields.io/github/license/povieira/noipy.svg?style=flat-square
        :target: https://pypi.python.org/pypi/noipy/
        :alt: License

Copyright (c) 2013 Pablo O Vieira (povieira).


.. :changelog:

Changelog
=========

1.4.2 (2015-08-22)
------------------

- **Bugfix**: storing auth credentials properly from ``stdin``
- Test case for ``--store`` option getting username/password from ``stdin``

1.4.0 (2015-04-25)
------------------

- Using the awesome `Requests HTTP library <https://github.com/kennethreitz/requests>`_
- Using `tox <http://tox.readthedocs.org/en/latest/>`_ in order to ease test against multiple Python versions

1.3.1 (2014-12-19)
------------------

- Send update to DDNS only if IP address has changed

1.3.0 (2014-12-16)
------------------

- Support for custom DDNS URL via ``--url`` parameter

1.2.3 (2014-10-10)
------------------

- Unit tests improvements and ``PluginsTest`` bug fixes
- Custom config directory feature bug fix (``--config`` argument)

1.2.2 (2014-07-03)
------------------

- PEP8'd code (Closes #5)
- Switched to `Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_
- Unit test improvement
- Minor feature: custom config directory via ``-c`` or ``--config`` argument.

1.2.1 (2014-06-30)
------------------

- Bug fix (execution via command line. issue #5)

1.2.0 (2014-04-21)
------------------

- Support for `DuckDNS domains update <https://www.duckdns.org/install.jsp>`_

1.1.4 (2013-08-29)
------------------

- Test case improvements
- `Coveralls.io <http://coveralls.io/>`_ support

1.1.3 (2013-07-24)
------------------

- Python 3.3 compatibility

1.1.0 (2013-05-15)
------------------

- Support for `DynDNS Update API <http://dyn.com/support/developers/api/>`_ 
- DDNS auth info storage changed

1.0.1 (2013-05-10)
------------------

- Added flexibility to DNS updater with ``abc.ABCMeta``
- Code organization
- Manual settings file removed (auth info can be stored via command line)

0.1.0 (2013-03-22)
------------------

- Conception


