README.md

Maintainer: @RustyBower

sopel-stocks

sopel-stocks is an stock lookup plugin for Sopel

Installing

If possible, use pip to install this plugin. Below are example commands; you might need to add sudo and/or call a different pip (e.g. pip3) depending on your system and environment. Do not use setup.py install; Sopel won't be able to load the plugin correctly.

Published release

pip install sopel-modules.stocks

From source

# Clone the repo, then run this in /path/to/sopel-stocks
pip install .

Configuring

You can automatically configure this plugin using the sopel configure --plugins command.

However, if you want or need to configure this plugin manually, you will need to define the following in ~/.sopel/default.cfg

[stocks]
api_key = API_KEY
provider = finnhub (or alphavantage/iexcloud)

Requirements

API Key (from 1 of the following providers)

https://www.alphavantage.co/support/#api-key
https://iexcloud.io/console/tokens
https://finnhub.io/dashboard (recommended)

Python Requirements

requests
sopel

Usage

.stock msft
<sopel> MSFT $123.37 1.6 (1.31%)⬆

.stock aapl amzn goog
<sopel> AAPL $150.83 -2.51 (-1.64%)⬇
<sopel> AMZN $97.06 -5.38 (-5.25%)⬇
<sopel> GOOG $90.445 -4.215 (-4.45%)⬇