https://github.com/colin-nolan/ip-communicator

Monitors and communicates changes of a machine's public IP address (DDNS alternative)
https://github.com/colin-nolan/ip-communicator

ip python slack

Last synced: about 1 month ago
JSON representation

Monitors and communicates changes of a machine's public IP address (DDNS alternative)

• Host: GitHub
• URL: https://github.com/colin-nolan/ip-communicator
• Owner: colin-nolan
• License: mit
• Created: 2018-12-09T13:35:44.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-12-09T23:30:49.000Z (over 7 years ago)
• Last Synced: 2025-01-23T06:29:03.267Z (over 1 year ago)
• Topics: ip, python, slack
• Language: Python
• Homepage:
• Size: 34.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/colin-nolan/ip-communicator.svg?branch=master)](https://travis-ci.org/colin-nolan/ip-communicator)

[![codecov](https://codecov.io/gh/colin-nolan/ip-communicator/branch/master/graph/badge.svg)](https://codecov.io/gh/colin-nolan/ip-communicator)

# IP Communicator

_Monitors and communicates changes of a machine's public IP address_

## Purpose

To monitor a machine's public IP address and to communicate changes to it using a communicator. 

Similar to a DDNS client but not coupled to DDNS.

## Usage

```

usage: ipcommunicator [-h] [-p CHECK_PERIOD] [-v] {slack}

Monitors and communicates changes of a machine's public IP address (v1.0.0b0)

positional arguments:

  {slack}               communicator to use to send notifications of updates

                        on the host's public IP address

optional arguments:

  -h, --help            show this help message and exit

  -p CHECK_PERIOD, --check-period CHECK_PERIOD

                        number of seconds between checking if the host's

                        public IP address has changed

  -v                    increase the level of log verbosity (add multiple

                        increase further)

```

### Communicator Plugins

#### Slack

Communicates IP address changes to a slack channel. Gets configuration from the environment variables:

`SLACK_TOKEN` `SLACK_CHANNEL` `SLACK_USERNAME`.

## Installation

Prerequisites

- Python 3.7+ (can be run entirely from Docker if you don't have Python 3.7).

The tool can be installed directly from GitHub:

```bash

pip install git+https://github.com/wtsi-hgi/ip-communicator@master#egg=ipcommunicator

```