stocktracer 0.3.0

Tools for aggregating efficient ways to consume and process publically traded equities on the US stock market. Includes support for SEC quarterly data processing.

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

pip install stocktracer

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

# Help
stocktracer

Developers

Make sure you have pipenv installed through a package manager or through pip.

pipenv install --dev

# Perform analysis
PYTHONPATH=src pipenv run python -m stocktracer analyze --tickers aapl,msft
PYTHONPATH=src pipenv run python -m stocktracer analyze --tickers aapl,msft -a stocktracer.analysis.diluted_eps
PYTHONPATH=src pipenv run python -m stocktracer analyze --tickers aapl,msft -a stocktracer.analysis.diluted_eps --report-format csv
PYTHONPATH=src pipenv run python -m stocktracer analyze --tickers aapl,msft -a stocktracer.analysis.diluted_eps --report-format json --report-file my_results.json

# Help
PYTHONPATH=src pipenv run python -m stocktracer

# Run Unit Tests
pipenv run pytest

More information can be found in 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.