Skip to content

Aggregate and modularize efficient and reliable tools for performing fundamental analysis on US securities

License

Notifications You must be signed in to change notification settings

gyund/fundamental-analysis

License PyPI - Python Version Test Status Coverage Status bear-ified Code style: black PyPI - Python Version PyPI - Downloads PyPI - Status

StockTracer

Stock Analysis Framework

The goal of this project is aggregate a variety of ways to consume information about a particular equity traded on the US stock market and provide a modular mechanism to process it. Core tenants of this project include:

  • Heavy data caching - don't download static data more than once
  • Efficient use of storage - leave data compressed while not in use
  • Batch Processing - We can't store all information in memory, so break problems up
  • Speed - Find and avoid bottlenecks of big data processing

Requirements

  • python 3.10+

Getting Started

Users

# basic install
pip install stocktracer

# with tensorflow dependencies for analysis modules
pip install stocktracer[tensorflow]

# Perform analysis
stocktracer analyze --tickers aapl,msft > report.txt

# Help
stocktracer

For development guides, see our documentation

Disclaimer

This project seeks to use publicly available information to perform security analysis and help perform long term risk analysis. Results provided from this project are generally for academic use only and are not considered advice or recommendations. This project makes no performance claims or guarantees. Please read the license for this project. Usage of any data is at your own risk.