Skip to content

Extension for LibreOffice Calc to access stock market data

License

Notifications You must be signed in to change notification settings

ikyquocked/Financials-Extension

 
 

Repository files navigation

Financials-Extension

This is a Python based extension for LibreOffice Calc to make stock market, index and FX data available in Calc spreadsheets - currently supporting Yahoo's, Financial Times' and Google's (without FX data) finance websites using old-fashioned web scraping.

Feedback requested:

Please provide feedback about using the extension here: cmallwitz#10

System requirements:

This extension requires the following Python 3 packages (on top of standard libs): dateutil, pytz, pyparsing. These are from within LibreOffice, so if your LibreOffice comes with it's own Python runtime (e.g. Windows) they need to be installed there instead somewhere else in the system.

On Ubuntu 18 and 20, dateutil and pytz may already be installed, but you can get all you need by running

  • sudo apt-get install python3-dateutil python3-tz python3-pyparsing

On Debian 10, the following steps have worked for me (as root)

  • apt install python3-pip
  • pip3 install python-dateutil pytz pyparsing

Users on Windows 10 have reported this to work - as LibreOffice on Windows ships with its own, but minimal Python runtime a few more steps are required

  • Download the script https://bootstrap.pypa.io/get-pip.py to your computer

  • Start a Command Prompt (CMD) as Administrator

  • on this command prompt run (change path as required)

    "c:\Program Files\LibreOffice\program\python.exe" c:\temp\get-pip.py

  • and then

    "c:\Program Files\LibreOffice\program\python.exe" -m pip install python-dateutil pytz pyparsing

Usage:

Under 'Releases' on GitHub there is downloadable Financials-Extension.oxt file - load it into Calc under menu item: Tools, Extension Manager...

Getting data should be a simple as having this in a cell:

  • =GETREALTIME("IBM",21,"YAHOO")
  • =GETREALTIME("NYSE:IBM",21,"GOOGLE")
  • =GETREALTIME("IBM:NYQ",21,"FT")
  • =GETHISTORIC("IBM",90,"2020-12-01","YAHOO")

Codes 21 and 90 stand for "last price" and "close" (see below), respectively. Only Yahoo has historic data available.

There is a file examples.ods there too with usage examples and possible arguments to functions.

You have to check the respective websites to work out what symbol is the right one for you. If a website doesn't have the symbol/asset you want, this extension can't help you either. Having said that, I mostly look at US and West European equities, ETFs and mutual funds and major FX rates - if you have issues with the data available for other assets or assets in other regions, drop me a line (best to include full URLs and possibly the same asset listed on more than one site for comparison). While data for last price is most likely consistent across sites, they may differ for other data points.

LibreOffice: using , (comma) vs ; (semicolon) to separate arguments in formula

There is a setting in "Tools" / "Options..." / "LibreOffice Calc" / "Formula" called "Functions". Here the user can specify the character used to separate arguments in formula.

Mine is set to , (comma) - when I enter ; (semicolon) in a formula (Ubuntu / UK English), no error is reported but the semicolon is converted to , (comma)

Depending on your system's language and default LibreOffice settings, you maybe better off using ; instead of , in your formulas.

List of supported data points

You can either specify numbers or names (lower or upper case) - not all bits are available from all sources and they are not necessarily consistent across sources either.

Name Code YAHOO FT GOOGLE YAHOO (historic)
PREV_CLOSE 5 Yes Yes Yes
OPEN 6 Yes Yes Yes Yes
CHANGE 7 Yes Yes Yes
LAST_PRICE_DATE 8 Yes Yes Yes
LAST_PRICE_TIME 10 Yes Yes Yes
CHANGE_IN_PERCENT 11 Yes Yes Yes
LOW 14 Yes Yes Yes Yes
HIGH 16 Yes Yes Yes Yes
LAST_PRICE 21 Yes Yes Yes
HIGH_52_WEEK 24 Yes Yes Yes
LOW_52_WEEK 26 Yes Yes Yes
MARKET_CAP 27 Yes Yes Yes
VOLUME 35 Yes Yes No Yes
AVG_DAILY_VOL_3MONTH 39 Yes Yes No
BETA 67 Yes Yes No
EPS 68 Yes Yes No
PE_RATIO 69 Yes Yes No
DIV 70 Yes Yes No
DIV_YIELD 71 Yes Yes No
EX_DIV_DATE 72 Yes Yes No
PAYOUT_RATIO 73 Yes No No
CLOSE 90 No No No Yes
ADJ_CLOSE 91 No No No Yes
SECTOR 98 Yes Yes No
INDUSTRY 99 Yes Yes No
TICKER 101 Yes Yes Yes
EXCHANGE 102 Yes No Yes
CURRENCY 103 Yes Yes Yes
NAME 104 Yes Yes Yes
TIMEZONE 105 Yes Yes Yes

Dealing with missing data:

A hint for using LibreCalc: if you want to refresh data you can press SHIFT-CTRL-F9 - this will force a recalculation of all formulas in all sheets.

Secondly the extension saves some debug information under your user directory in a directory ".financials-extension": the HTML for each stock symbol is saved in a separate file (depending on the source and ticker symbol). You can open it your favorite web browser (or other tools) to check if the page actually contained the information you are looking for. If it does, the file trace.log has a record of all calls to the extension with the value returned to LibreOffice. Otherwise, the file extension.log in the same location might have more details about errors or exceptions.

Build:

You will need the LibreOffice SDK installed.

On my system (Ubuntu) I installed packages: libreoffice-dev libreoffice-java-common libreoffice-script-provider-python

# depending on your location...

cd ~/tech/IdeaProjects/Financials-Extension/

python3 -m unittest discover src

# This builds file Financials-Extension.oxt

./compile.sh

Tested with:

  • Debian 10.3 / LibreOffice Calc 6.1.5.2 / Python 3.7.3
  • Ubuntu 20.10 / LibreOffice Calc 7.0.3.1 / Python 3.8.6
  • Ubuntu 20.04 / LibreOffice Calc 6.4.3.2 / Python 3.8.2
  • Ubuntu 19.10 / LibreOffice Calc 6.3.5.2 / Python 3.7.6
  • Ubuntu 19.04 / LibreOffice Calc 6.2 / Python 3.7.3
  • Ubuntu 18.04.5 / LibreOffice Calc 6 / Python 3.6.9
  • Ubuntu 18.04 / LibreOffice Calc 6 / Python 3.6.7
  • Ubuntu 16.04 / LibreOffice Calc 5 (previous versions)

About

Extension for LibreOffice Calc to access stock market data

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.0%
  • Shell 1.0%