Skip to content

Latest commit

 

History

History
168 lines (95 loc) · 4.44 KB

README.rst

File metadata and controls

168 lines (95 loc) · 4.44 KB

noipy: DDNS update tool

Snap Status Snap Trending https://api.travis-ci.org/pv8/noipy.svg?branch=master Code Health Maintainability https://zenodo.org/badge/doi/10.5281/zenodo.29017.svg?style=flat-square

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:

Installation

Install with pip:

$ pip install noipy

Or with Snappy on supported distros:

$ sudo snap install noipy

Note: noipy will also install the Requests HTTP library.

Usage

Basic usage of noipy command line tool:

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

For DuckDNS provider, the command line would look like this:

$ 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 your auth information with --store option.

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

You can also specify a custom DDNS URL (thanks to @jayennis22):

$ 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:

$ 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:

$ noipy --help

Storing auth information

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

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

Or simply:

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

And type username and password when required.

Note: password is stored simply encoded with Base64 method and is not actually encrypted!

Running tests

Install tests dependencies (tox and flake8):

$ pip install -r requirements_dev.txt

Test the code against all supported Python versions and check it against PEP8 with tox:

$ tox

Check PEP8 only:

$ tox -e pep8

Copyright & License

License

Copyright (c) 2013 Pablo Vieira (pv8).