<p align="center">
<a href='https://github.com/gyund/fundamental-analysis/blob/main/LICENSE'><img alt="License" src="https://img.shields.io/github/license/gyund/fundamental-analysis"></a>
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/stocktracer">
<a href='https://github.com/gyund/fundamental-analysis/actions/workflows/python.yml'><img alt="Test Status" src="https://github.com/gyund/fundamental-analysis/actions/workflows/python.yml/badge.svg?service=github"></a>
<a href='https://coveralls.io/github/gyund/fundamental-analysis?branch=main'><img src='https://coveralls.io/repos/github/gyund/fundamental-analysis/badge.svg' alt='Coverage Status' /></a>
<a href="https://beartype.readthedocs.io"><img src="https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg?" alt="bear-ified"></a>
<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black"></a>
<a href='https://pypi.org/project/stocktracer/'><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/v/stocktracer"></a>
<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/stocktracer">
<img alt="PyPI - Status" src="https://img.shields.io/pypi/status/stocktracer">
</p>
# 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
```sh
# 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](https://gyund.github.io/fundamental-analysis/getting-started)
## 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](LICENSE)
for this project. Usage of any data is at your own risk.
Raw data
{
"_id": null,
"home_page": "https://github.com/gyund/fundamental-analysis/",
"name": "stocktracer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<3.12",
"maintainer_email": "",
"keywords": "sec-tools,fundamental analysis,stocks",
"author": "Gary Yund",
"author_email": "gyund@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/29/99/92d52182ee9b70e06da6adf2381420445f4773c608db5f4f5be2737b6d0a/stocktracer-0.4.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href='https://github.com/gyund/fundamental-analysis/blob/main/LICENSE'><img alt=\"License\" src=\"https://img.shields.io/github/license/gyund/fundamental-analysis\"></a>\n <img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/stocktracer\">\n <a href='https://github.com/gyund/fundamental-analysis/actions/workflows/python.yml'><img alt=\"Test Status\" src=\"https://github.com/gyund/fundamental-analysis/actions/workflows/python.yml/badge.svg?service=github\"></a>\n <a href='https://coveralls.io/github/gyund/fundamental-analysis?branch=main'><img src='https://coveralls.io/repos/github/gyund/fundamental-analysis/badge.svg' alt='Coverage Status' /></a>\n <a href=\"https://beartype.readthedocs.io\"><img src=\"https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg?\" alt=\"bear-ified\"></a>\n <a href=\"https://github.com/psf/black\"><img src=\"https://img.shields.io/badge/code%20style-black-000000.svg\" alt=\"Code style: black\"></a>\n <a href='https://pypi.org/project/stocktracer/'><img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/v/stocktracer\"></a>\n <img alt=\"PyPI - Downloads\" src=\"https://img.shields.io/pypi/dm/stocktracer\">\n <img alt=\"PyPI - Status\" src=\"https://img.shields.io/pypi/status/stocktracer\">\n</p>\n\n# StockTracer\n\n**Stock Analysis Framework**\n\nThe 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:\n\n- **Heavy data caching** - don't download static data more than once\n- **Efficient use of storage** - leave data compressed while not in use\n- **Batch Processing** - We can't store all information in memory, so break problems up\n- **Speed** - Find and avoid bottlenecks of big data processing\n\n## Requirements\n\n- `python 3.10+`\n\n## Getting Started\n\n### Users\n\n```sh\n# basic install\npip install stocktracer\n\n# with tensorflow dependencies for analysis modules\npip install stocktracer[tensorflow]\n\n# Perform analysis\nstocktracer analyze --tickers aapl,msft > report.txt\n\n# Help\nstocktracer\n\n```\n\nFor development guides, see our [documentation](https://gyund.github.io/fundamental-analysis/getting-started)\n\n## Disclaimer\n\nThis project seeks to use publicly available information to perform security analysis and\nhelp perform long term risk analysis. Results provided from this project are generally for \nacademic use only and are not considered advice or recommendations. This project makes no\nperformance claims or guarantees. Please read the [license](LICENSE) \nfor this project. Usage of any data is at your own risk.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Tools for aggregating efficient ways to consume and process publically traded equities on the US stock market. Includes support for SEC quarterly data processing.",
"version": "0.4.0",
"project_urls": {
"Bug Tracker": "https://github.com/gyund/fundamental-analysis/issues",
"Documentation": "https://gyund.github.io/fundamental-analysis/",
"Homepage": "https://github.com/gyund/fundamental-analysis/",
"Repository": "https://github.com/gyund/fundamental-analysis/"
},
"split_keywords": [
"sec-tools",
"fundamental analysis",
"stocks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bf21779f3c3887e088c9f039775f81545855f90b1977f236f90107679c23a41e",
"md5": "b5ff83e3dd86444c6bfd18a834abdb4d",
"sha256": "c86f00aa03a6616b0f3d48545ce15a32f106c85f0dde173ee9639141100ef793"
},
"downloads": -1,
"filename": "stocktracer-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b5ff83e3dd86444c6bfd18a834abdb4d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<3.12",
"size": 27892,
"upload_time": "2023-06-03T15:55:05",
"upload_time_iso_8601": "2023-06-03T15:55:05.697910Z",
"url": "https://files.pythonhosted.org/packages/bf/21/779f3c3887e088c9f039775f81545855f90b1977f236f90107679c23a41e/stocktracer-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "299992d52182ee9b70e06da6adf2381420445f4773c608db5f4f5be2737b6d0a",
"md5": "2255bcb8eebeebbced56aac485585c12",
"sha256": "26db1b3ea44cc684614f3416752240d1077350b8a8e6961f762d860857258457"
},
"downloads": -1,
"filename": "stocktracer-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "2255bcb8eebeebbced56aac485585c12",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<3.12",
"size": 24825,
"upload_time": "2023-06-03T15:55:07",
"upload_time_iso_8601": "2023-06-03T15:55:07.542364Z",
"url": "https://files.pythonhosted.org/packages/29/99/92d52182ee9b70e06da6adf2381420445f4773c608db5f4f5be2737b6d0a/stocktracer-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-03 15:55:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gyund",
"github_project": "fundamental-analysis",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "stocktracer"
}
JSON
