Skip to main content

Stock Market BI

Project description

Stock Market BI

Stock Market BI is an Open Source Business Intelligence platform written in Python for analysing Stock Market data.

This is an experimental alpha release and should not be used for production purposes and must not used for making investment decisions. Please have a look around. Feedback would be very welcome.

This README is a brief introduction. For more information see:

For support and feature requests:

  1. Ask for help on the forum.
  2. If you can't resolve it via the forum, raise a bug or feature request on the GitHub issue tracker.

Stock Market BI is modular. Built-in modules:

The following add-on modules are planned:

  • NZ Statistics

DISCLAIMER: I (Chris Brown) am not a Financial professional, stock broker or Financial advisor. I am not regulated by any Financial authorities. I may invest on the global markets and may own stocks, derivatives or other financial instruments at any given time. I do not make recommendations on what to invest in and nothing you read in connection with Stock Market BI should be taken as such. I do not take responsiblity for the advice, information or actions of third-parties involved with Stock Market BI including but not limited to software and/or website users, forum members, contributors and data providers. MOST OF THE DATA AVAILABLE VIA STOCK MARKET BI IS FROM THIRD-PARTY PROVIDERS. YOU ARE RESPONSIBLE FOR DISCOVERING AND COMPLYING WITH THEIR COPYRIGHT AND LICENSING REQUIREMENTS. YOU MUST NOT TAKE ANY INFORMATION FROM STOCK MARKET BI, FROM ITS OWNER, FROM ASSOCIATED THIRD PARTIES, ON ITS WEBSITE OR FROM RELATED DOCUMENTS AS TAX, FINANCIAL, INVESTMENT OR LEGAL ADVICE: IT IS YOUR RESPONSIBILITY TO VALIDATE ANY INFORMATION YOU GET FROM THESE SOURCES. YOU MUST DO YOUR OWN RESEARCH AND ANALYSIS BEFORE MAKING ANY INVESTMENT. YOU SHOULD SEEK INDEPENDENT PROFESSIONAL ADVICE BEFORE MAKING INVESTMENT DECISIONS.

LICENSE: Copyright (c) 2019 Chris Brown Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


#Installation

##Create virtual environment

pip install virtualenv

python -m venv stockmarketbi

Open .vscode/settings.json

Modify pythonPath

"python.pythonPath": "C:\\Users\\Chris\\AppData\\Local\\Programs\\Python\\Python38\\python.exe"

becomes

"python.pythonPath": "C:/apps_venv/stockmarketbi/Scripts/python.exe"

##Install requirements

C:\apps_venv\stockmarketbi\Scripts\activate

(stockmarketbi) C:\apps\stockmarketbi>python --version Python 3.8.0

pip install -r requirements.txt

(stockmarketbi) C:\apps\stockmarketbi>pip install -r requirements.txt

(stockmarketbi) C:\apps\stockmarketbi>pip list Package Version


beautifulsoup4 4.8.1 html5lib 1.0.1 pip 19.2.3 psycopg2 2.8.4 pytz 2019.3 setuptools 41.2.0 six 1.13.0 soupsieve 1.9.5 SQLAlchemy 1.3.12 webencodings 0.5.1

##Create config file

If you don't know home dir:

PS C:\apps\stockmarketbi> python
Python 3.8.0 (tags/v3.8.0:fa919fd, Oct 14 2019, 19:37:50) [MSC v.1916 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> from pathlib import Path
>>> str(Path.home())
'C:\\Users\\Chris'

Put .stockmarketbi.cfg in home dir containing:

{
    "user": "chris",
    "password": "password",
    "host": "127.0.0.1",
    "port": 5432,
    "database": "sec_dev",
    "path": "C:\\apps_data\\stockmarketbi\\sec_fin_archive"
}

Change owner to you & permissions to 400 or whatever

##CLI

##API

##Extending Stock Market BI

##Contributing to Stock Market BI

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for stockmarketbi, version 0.0.1a2
Filename, size File type Python version Upload date Hashes
Filename, size stockmarketbi-0.0.1a2-py3-none-any.whl (13.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size stockmarketbi-0.0.1a2.tar.gz (12.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page