curnot

command module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 12, 2019 License: Apache-2.0 Imports: 9 Imported by: 0

README

Currency Notifier

Small golang program capable of periodically checking different currencies exchange rates with different providers.

Implemented providers

Have a look at releases to download compiled version

Config example

# Configure interval of notifications. Default is 30 minutes
# Examples:
# 60s => 60 seconds
# 30m => 30 minutes
# 2h => 2 hours
interval: 30m

# Providers section is configuring all possible providers that you can use.
# I recommend to use currencyConverter by default, but if you need openExchangeRates.org
# you just need to uncomment the configuration and paste your application key
providers:
  currencyConverter:
    app_key: "<PASTE YOUR KEY HERE>"
#  openExchangeRates:
#    app_key: "<PASTE YOUR KEY HERE>"

# Currencies section is configuring all the currencies you would like to track.
# Feel free to add more, but 1 currency rate will result in 1 notification.
currencies:
  - from: USD
    to: PLN
    provider_name: currencyConverter
    alert:
      below: 3.75
      above: 3.85
      #any_change: true
# Notifiers section is configuring available notifiers that can be used. 
# You can disable each one by commenting it out.
notifiers:
  desktop: ~
  email:
    receiver:
      email: john@example.com
    connection_parameters:
      host: example.com
      port: 465
      username: john@example.com
      password: secretPassword

Project is under development

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL