https://github.com/sopel-irc/sopel-stocks

A working re-implementation of the stocks module for Sopel
https://github.com/sopel-irc/sopel-stocks

Last synced: 7 months ago
JSON representation

A working re-implementation of the stocks module for Sopel

• Host: GitHub
• URL: https://github.com/sopel-irc/sopel-stocks
• Owner: sopel-irc
• License: mit
• Created: 2018-12-15T05:06:19.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-22T19:42:29.000Z (12 months ago)
• Last Synced: 2024-10-29T04:19:38.180Z (8 months ago)
• Language: Python
• Size: 69.3 KB
• Stars: 3
• Watchers: 5
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Python Tests](https://github.com/sopel-irc/sopel-stocks/actions/workflows/python-tests.yml/badge.svg?branch=master)](https://github.com/sopel-irc/sopel-stocks/actions/workflows/python-tests.yml)

[![PyPI version](https://badge.fury.io/py/sopel-modules.stocks.svg)](https://badge.fury.io/py/sopel-modules.stocks)

[![Total alerts](https://img.shields.io/lgtm/alerts/g/sopel-irc/sopel-stocks.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/sopel-irc/sopel-stocks/alerts/)

[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/sopel-irc/sopel-stocks.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/sopel-irc/sopel-stocks/context:python)

**Maintainer:** [@RustyBower](https://github.com/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

     MSFT $123.37 1.6 (1.31%)⬆

    .stock aapl amzn goog

     AAPL $150.83 -2.51 (-1.64%)⬇

     AMZN $97.06 -5.38 (-5.25%)⬇

     GOOG $90.445 -4.215 (-4.45%)⬇