Code Monkey home page Code Monkey logo

noipy's Introduction

noipy: DDNS update tool

https://img.shields.io/pypi/v/noipy.svg?style=flat-square https://img.shields.io/pypi/dm/noipy.svg?style=flat-square https://img.shields.io/travis/povieira/noipy/master.svg?style=flat-square https://img.shields.io/coveralls/povieira/noipy/master.svg?style=flat-square Code Health https://img.shields.io/badge/DOI-10.5281%2Fzenodo.13320-blue.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

To install noipy, simply:

$ pip install noipy

Note: noipy will also install the Requests HTTP library if you haven't yet.

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 login 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!

Contributing

Improvements & Troubleshooting

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

  1. Open an issue
  2. Fork the project
  3. Do your magic
  4. Please, PEP8 and test your code
  5. Is everything working? Send a pull request

Running tests

First, install tests dependencies (tox and flake8):

$ pip install -r dev-requirements.txt

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

$ tox

Or you can to test against a specific version:

$ tox -e {version}

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

Don't forget to run pep8:

$ tox -e pep8

Copyright & License

License

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

noipy's People

Contributors

pv8 avatar jayennis22 avatar eugenesiow avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.