diff --git a/inkycal/__init__.py b/inkycal/__init__.py index b191d4c..edbacf6 100644 --- a/inkycal/__init__.py +++ b/inkycal/__init__.py @@ -9,9 +9,8 @@ import inkycal.modules.inkycal_feeds import inkycal.modules.inkycal_todoist import inkycal.modules.inkycal_image import inkycal.modules.inkycal_jokes +import inkycal.modules.inkycal_stocks # import inkycal.modules.inkycal_server # Main file -from inkycal.main import Inkycal - -# Added by module adder +from inkycal.main import Inkycal \ No newline at end of file diff --git a/inkycal/modules/__init__.py b/inkycal/modules/__init__.py index e15fc9b..0a3921b 100644 --- a/inkycal/modules/__init__.py +++ b/inkycal/modules/__init__.py @@ -6,3 +6,4 @@ from .inkycal_todoist import Todoist from .inkycal_image import Inkyimage from .inkycal_jokes import Jokes #from .inkycal_server import Inkyserver +from .inkycal_stocks import Stocks \ No newline at end of file diff --git a/inkycal/modules/inkycal_stocks.py b/inkycal/modules/inkycal_stocks.py new file mode 100644 index 0000000..0d20ae2 --- /dev/null +++ b/inkycal/modules/inkycal_stocks.py @@ -0,0 +1,145 @@ +#!/usr/bin/python3 +# -*- coding: utf-8 -*- +""" +Stocks Module for Inky-Calendar Project + +Version 0.3: Added support for web-UI of Inkycal 2.0.0 +Version 0.2: Migration to Inkycal 2.0.0 +Version 0.1: Migration to Inkycal 2.0.0b + +by https://github.com/worstface +""" +from inkycal.modules.template import inkycal_module +from inkycal.custom import * + +try: + import yfinance as yf +except ImportError: + print('yfinance is not installed! Please install with:') + print('pip3 install yfinance') + +filename = os.path.basename(__file__).split('.py')[0] +logger = logging.getLogger(filename) + +class Stocks(inkycal_module): + + name = "Stocks - Displays stock market infos from Yahoo finance" + + # optional parameters + optional = { + + "tickers": { + + "label": "You can display any information by using " + "the respective symbols that are used by Yahoo! Finance. " + "Separate multiple symbols with a comma sign e.g. " + "TSLA, U, NVDA, EURUSD=X" + } + } + + def __init__(self, config): + + super().__init__(config) + + config = config['config'] + + # If tickers is a string from web-ui, convert to a list, else use + # tickers as-is i.e. for tests + if config['tickers'] and isinstance(config['tickers'], str): + self.tickers = config['tickers'].split(',') #returns list + else: + self.tickers = config['tickers'] + + # give an OK message + print(f'{filename} loaded') + + def generate_image(self): + """Generate image for this module""" + + # Define new image size with respect to padding + im_width = int(self.width - (2 * self.padding_left)) + im_height = int(self.height - (2 * self.padding_top)) + im_size = im_width, im_height + logger.info('image size: {} x {} px'.format(im_width, im_height)) + + # Create an image for black pixels and one for coloured pixels (required) + im_black = Image.new('RGB', size = im_size, color = 'white') + im_colour = Image.new('RGB', size = im_size, color = 'white') + + # Check if internet is available + if internet_available() == True: + logger.info('Connection test passed') + else: + raise Exception('Network could not be reached :/') + + # Set some parameters for formatting feeds + line_spacing = 1 + line_height = self.font.getsize('hg')[1] + line_spacing + line_width = im_width + max_lines = (im_height // (self.font.getsize('hg')[1] + line_spacing)) + + logger.debug(f"max_lines: {max_lines}") + + # Calculate padding from top so the lines look centralised + spacing_top = int( im_height % line_height / 2 ) + + # Calculate line_positions + line_positions = [ + (0, spacing_top + _ * line_height ) for _ in range(max_lines)] + + logger.debug(f'line positions: {line_positions}') + + parsed_tickers = [] + parsed_tickers_colour = [] + + for ticker in self.tickers: + logger.info(f'preparing data for {ticker}...') + + yfTicker = yf.Ticker(ticker) + + try: + stockInfo = yfTicker.info + stockName = stockInfo['shortName'] + except Exception: + stockName = ticker + logger.warning(f"Failed to get '{stockName}' ticker info! Using " + "the ticker symbol as name instead.") + + stockHistory = yfTicker.history("2d") + previousQuote = (stockHistory.tail(2)['Close'].iloc[0]) + currentQuote = (stockHistory.tail(1)['Close'].iloc[0]) + currentGain = currentQuote-previousQuote + currentGainPercentage = (1-currentQuote/previousQuote)*-100 + + tickerLine = '{}: {:.2f} {:+.2f} ({:+.2f}%)'.format( + stockName, currentQuote, currentGain, currentGainPercentage) + + logger.info(tickerLine) + parsed_tickers.append(tickerLine) + + if currentGain < 0: + parsed_tickers_colour.append(tickerLine) + else: + parsed_tickers_colour.append("") + + # Write/Draw something on the black image + for _ in range(len(parsed_tickers)): + if _+1 > max_lines: + logger.error('Ran out of lines for parsed_ticker_colour') + break + write(im_black, line_positions[_], (line_width, line_height), + parsed_tickers[_], font = self.font, alignment= 'left') + + # Write/Draw something on the colour image + for _ in range(len(parsed_tickers_colour)): + if _+1 > max_lines: + logger.error('Ran out of lines for parsed_tickers_colour') + break + write(im_colour, line_positions[_], (line_width, line_height), + parsed_tickers_colour[_], font = self.font, alignment= 'left') + + # Save image of black and colour channel in image-folder + return im_black, im_colour + +if __name__ == '__main__': + print(f'running {filename} in standalone/debug mode') diff --git a/inkycal/tests/inkycal_stocks_test.py b/inkycal/tests/inkycal_stocks_test.py new file mode 100644 index 0000000..6ed6334 --- /dev/null +++ b/inkycal/tests/inkycal_stocks_test.py @@ -0,0 +1,75 @@ +import unittest +from inkycal.modules import Stocks as Module + +tests = [ +{ + "position": 1, + "name": "Stocks", + "config": { + "size": [528, 20], + "tickers": ['TSLA', 'AMD', 'NVDA', '^DJI', 'BTC-USD', 'EURUSD=X'], + "padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en" + } +}, +{ + "position": 1, + "name": "Stocks", + "config": { + "size": [528, 20], + "tickers": [], + "padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en" + } +}, +{ + "position": 1, + "name": "Stocks", + "config": { + "size": [528, 200], + "tickers": ['TSLA', 'AMD', 'NVDA', '^DJI', 'BTC-USD', 'EURUSD=X'], + "padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en" + } +}, +{ + "position": 1, + "name": "Stocks", + "config": { + "size": [528, 800], + "tickers": ['TSLA', 'AMD', 'NVDA', '^DJI', 'BTC-USD', 'EURUSD=X'], + "padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en" + } +}, +{ + "position": 1, + "name": "Stocks", + "config": { + "size": [528, 100], + "tickers": "TSLA,AMD,NVDA,^DJI,BTC-USD,EURUSD=X", + "padding_x": 10, "padding_y": 10, "fontsize": 12, "language": "en" + } +}, +{ + "position": 1, + "name": "Stocks", + "config": { + "size": [528, 400], + "tickers": ['TSLA', 'AMD', 'NVDA', '^DJI', 'BTC-USD', 'EURUSD=X'], + "padding_x": 10, "padding_y": 10, "fontsize": 14, "language": "en" + } +}, +] + +class module_test(unittest.TestCase): + def test_get_config(self): + print('getting data for web-ui...', end = "") + Module.get_config() + print('OK') + + def test_generate_image(self): + for test in tests: + print(f'test {tests.index(test)+1} generating image..') + module = Module(test) + module.generate_image() + print('OK') + +if __name__ == '__main__': + unittest.main() diff --git a/requirements.txt b/requirements.txt index d656a71..f47515d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -8,5 +8,7 @@ arrow>=0.15.6 # time operations Flask==1.1.2 # webserver Flask-WTF==0.14.3 # webforms todoist-python==8.1.2 # todoist api -sphinxemoji==0.1.8 # for emoji support on documentation +yfinance==0.1.55' # yahoo stocks +sphinxemoji==0.1.8 # for emoji support on documentation sphinx-rtd-theme==0.5.0 # better theme for documentation +recommonmark==0.6.0 # markdown support for documentation diff --git a/setup.py b/setup.py index 1957f0c..e439423 100644 --- a/setup.py +++ b/setup.py @@ -17,12 +17,13 @@ __install_requires__ = ['pyowm==3.1.1', # weather 'Pillow>=7.1.1' , # imaging 'icalendar==4.0.6', # iCalendar parsing 'recurring-ical-events==0.1.17b0',# parse recurring events - 'feedparser==5.2.1', # parse RSS-feeds + 'feedparser==5.2.1', # RSS-feeds 'numpy>=1.18.2', # image pre-processing 'arrow>=0.15.6', # time handling 'Flask==1.1.2', # webserver 'Flask-WTF==0.14.3', # webforms 'todoist-python==8.1.2', # todoist api + 'yfinance==0.1.55', # yahoo stocks ] __classifiers__ = [