https://github.com/whwright/stock-widget
stock ticker widget for awesome WM
https://github.com/whwright/stock-widget
awesome-wm widget
Last synced: 3 months ago
JSON representation
stock ticker widget for awesome WM
- Host: GitHub
- URL: https://github.com/whwright/stock-widget
- Owner: whwright
- License: mit
- Created: 2017-07-12T04:20:08.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-10T21:22:46.000Z (over 2 years ago)
- Last Synced: 2024-10-14T01:06:24.079Z (7 months ago)
- Topics: awesome-wm, widget
- Language: Lua
- Size: 13.7 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-awesomewm-modules-widgets-and-libraries - stock-widget
- awesome-awesomewm-modules-widgets-and-libraries - stock-widget
README
stock-widget
============
A basic stock ticker widget for awesome WM.
Inspiration taken from [deficient](https://github.com/deficient) widgets.
### Installation
First you need an API key from https://www.alphavantage.co/, and place it in `/opt/stock-widget/alphavantage`
```bash
cd ~/.config/awesome/
git clone [email protected]:whwright/stock-widget.git
```
Then, in your rc.lua:
```lua
local stock_widget = require("stock-widget")
stock = stock_widget({symbol = "NYSE:HD"})
-- add the widget to your wibox
{
-- right widgets
...
stock.widget
...
}
```
### Config
The text can be configured with the following properties
```lua
stock_widget({
text_format = "${symbol_color_on}${symbol}${symbol_color_off} ${price_color_on}\$${price}${price_color_off} ${change_color_on}${change}%${change_color_off}",
symbol_color = "white",
price_color = nil,
gain_color = "green",
loss_color = "red",
timeout = 60,
get_stock_price_location = nil
})
```
`get_stock_price_location` is used to find the location of `get_stock_price.py`. By default, it will try to find the
script in your awesome config folder, or in the directory `stock-widget` in your awesome config folder (in case you
have cloned this repo as sub module). If that doesn't work for your use case, you can always override the directory containing the script with `get_stock_price_location`.