https://github.com/fclairamb/followthestock

Stock change XMPP alert program
https://github.com/fclairamb/followthestock

Last synced: about 1 year ago
JSON representation

Stock change XMPP alert program

• Host: GitHub
• URL: https://github.com/fclairamb/followthestock
• Owner: fclairamb
• Created: 2014-03-20T23:30:45.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2024-04-01T20:47:07.000Z (about 2 years ago)
• Last Synced: 2025-03-23T22:53:24.936Z (about 1 year ago)
• Language: Go
• Homepage:
• Size: 57.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Follow the stock

It follows some stocks on [boursorama](http://www.boursorama.com) and send some alerts through XMPP when it detects some changes over the subscribed percentage threshold.

# Command line interface

Here are the command line interfaces arguments to start the app:

    usage: followthestock -config 

      -config="/etc/followthestock/followthestock.conf": Config file

      -console=false: Use console

      -show-config=false: Show config

# Config file

The config file looks something like that:

    [general]

    exactTiming = false

    

    [xmpp]

    username = 

    password = 

    server = talk.google.com:443

    notls = false

    debug = true

    activityWatchdogMinutes = 30

    [db]

    # In the current working directory (should be /var/lib/followthestock)

    file = followthestock.db

# Client comands

Each client can send the following commands:

* `!help` - Display help

* `!s  ` - Subscribe to variation about a stock

* `!u ` - Unsubscribe from a stock

* `!g ` - Get data about a stock

* `!ls` - List currently monitored stocks

* `!v   ` - Register the cost of our current stocks to calculate the added value

* `!pause ` - Pause alerts for X days

* `!resume` - Resume alerts

* `!uptime` - Bot uptime

Here are valid stock formats:

* `RNO` is like `FR:RNO`, which is the french "RENAULT" stock

* `US:RNO` is the "RHINO RESOURCE PARTNERS LP" stock

* `FR0011574110` is like `W:FR0011574110` which is the "SOGEN 50C 0614S" warrant

# Stocks data source

The stocks are fetched from [boursorama](http://www.boursorama.com). It is not an official API, it might not be legal to fetch data and it might not work in the future.

# Debian packages

Debian packages are automatically generated here:

 http://94.23.55.152/followthestock/dist/package/