stock-analysis-program


Namestock-analysis-program JSON
Version 1.0.8 PyPI version JSON
download
home_pagehttps://vcwtech.com/stock-analysis-program
SummaryA Python-based toolkit for fetching and visualizing financial data and metrics for stocks.
upload_time2024-03-23 09:34:56
maintainerNone
docs_urlNone
authorThaddeus Thomas
requires_python<4.0,>=3.11
licenseMIT
keywords
VCS
bugtrack_url
requirements pytest pandas numpy matplotlib yfinance
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Stock Analysis Program

[![Upload Python Package](https://github.com/Visionary-Code-Works/StockAnalysisProgram/actions/workflows/python_publish.yml/badge.svg)](https://github.com/Visionary-Code-Works/StockAnalysisProgram/actions/workflows/python_publish.yml)

## Overview

The Stock Analysis Program is a Python-based toolkit designed to fetch and visualize financial data and metrics for stocks. It is ideal for financial analysts, traders, and anyone interested in stock market analysis. The program offers functionalities such as retrieving historical stock data, computing moving averages, analyzing revenue growth, and plotting financial metrics.

## Features

- **Data Fetching**: Retrieve historical data, financial summaries, and key metrics for stocks.
- **Data Visualization**: Visualize stock prices, financial metrics, and revenue growth.
- **Comparative Analysis**: Compare performance of different stocks and stock indices.
- **Customizability**: Modular design allows for easy customization and extension.

## Installation

To use this program, ensure you have Python installed on your system. Clone this repository and install the required dependencies:

```bash
git clone https://github.com/visionary-code-works/stock-analysis-program.git
cd stock-analysis-program
pip install -r requirements.txt
```

## Usage

The program consists of multiple Python classes categorized into Fetchers and Plotters.

### Fetchers

- `StockDataFetcher`
- `StockSummaryFetcher`
- `FinancialMetricsFetcher`
- `RevenueGrowthFetcher`

### Plotters

- `StockPricePlotter`
- `FinancialMetricsPlotter`
- `RevenueGrowthPlotter`
- `StockVolatilityPlotter`
- `StockExchangePerformancePlotter`
- `CurrentPricesTickerDisplay`

### Example

```python
from plotter.stock_price_plotter import StockPricePlotter

# Plotting stock prices for Apple and Microsoft
price_plotter = StockPricePlotter(['AAPL', 'MSFT'])
price_plotter.plot_closing_prices('2021-01-01', '2021-12-31')
```

## Documentation

For detailed documentation on each component, please refer to the `docs` directory.

- [Workflow](./docs/Workflow.md)
- [Plotter](./docs/Plotter.md)
- [Fetcher](./docs/Fetcher.md)
- [Documentation](./docs/documentation.md)

## Contributing

Contributions to enhance the program are welcome. Please fork the repository and submit a pull request with your changes.

## License

This project is licensed under the MIT License - see the LICENSE file for details.

Raw data

            {
    "_id": null,
    "home_page": "https://vcwtech.com/stock-analysis-program",
    "name": "stock-analysis-program",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Thaddeus Thomas",
    "author_email": "thaddeus.r.thomas@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/94/94/bd9acdd0bafd85e7df4f1a44f9cee73714c4619cc5bb92c177488dda80e9/stock_analysis_program-1.0.8.tar.gz",
    "platform": null,
    "description": "# Stock Analysis Program\n\n[![Upload Python Package](https://github.com/Visionary-Code-Works/StockAnalysisProgram/actions/workflows/python_publish.yml/badge.svg)](https://github.com/Visionary-Code-Works/StockAnalysisProgram/actions/workflows/python_publish.yml)\n\n## Overview\n\nThe Stock Analysis Program is a Python-based toolkit designed to fetch and visualize financial data and metrics for stocks. It is ideal for financial analysts, traders, and anyone interested in stock market analysis. The program offers functionalities such as retrieving historical stock data, computing moving averages, analyzing revenue growth, and plotting financial metrics.\n\n## Features\n\n- **Data Fetching**: Retrieve historical data, financial summaries, and key metrics for stocks.\n- **Data Visualization**: Visualize stock prices, financial metrics, and revenue growth.\n- **Comparative Analysis**: Compare performance of different stocks and stock indices.\n- **Customizability**: Modular design allows for easy customization and extension.\n\n## Installation\n\nTo use this program, ensure you have Python installed on your system. Clone this repository and install the required dependencies:\n\n```bash\ngit clone https://github.com/visionary-code-works/stock-analysis-program.git\ncd stock-analysis-program\npip install -r requirements.txt\n```\n\n## Usage\n\nThe program consists of multiple Python classes categorized into Fetchers and Plotters.\n\n### Fetchers\n\n- `StockDataFetcher`\n- `StockSummaryFetcher`\n- `FinancialMetricsFetcher`\n- `RevenueGrowthFetcher`\n\n### Plotters\n\n- `StockPricePlotter`\n- `FinancialMetricsPlotter`\n- `RevenueGrowthPlotter`\n- `StockVolatilityPlotter`\n- `StockExchangePerformancePlotter`\n- `CurrentPricesTickerDisplay`\n\n### Example\n\n```python\nfrom plotter.stock_price_plotter import StockPricePlotter\n\n# Plotting stock prices for Apple and Microsoft\nprice_plotter = StockPricePlotter(['AAPL', 'MSFT'])\nprice_plotter.plot_closing_prices('2021-01-01', '2021-12-31')\n```\n\n## Documentation\n\nFor detailed documentation on each component, please refer to the `docs` directory.\n\n- [Workflow](./docs/Workflow.md)\n- [Plotter](./docs/Plotter.md)\n- [Fetcher](./docs/Fetcher.md)\n- [Documentation](./docs/documentation.md)\n\n## Contributing\n\nContributions to enhance the program are welcome. Please fork the repository and submit a pull request with your changes.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Python-based toolkit for fetching and visualizing financial data and metrics for stocks.",
    "version": "1.0.8",
    "project_urls": {
        "Documentation": "https://github.com/visionary-code-works/stock-analysis-program/docs",
        "Homepage": "https://vcwtech.com/stock-analysis-program",
        "Repository": "https://github.com/visionary-code-works/stock-analysis-program"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "18dbda4ec828b4de61b64a07e18e87b93a840df2f0ee279766d3d4efcf5b8850",
                "md5": "989e4e8cc9959ee50c66423e57ca6817",
                "sha256": "4d0bedb3b61d40b2e4c2f9d575fd6e123ae9cdcd693fc567bec916de66c591c7"
            },
            "downloads": -1,
            "filename": "stock_analysis_program-1.0.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "989e4e8cc9959ee50c66423e57ca6817",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 18443,
            "upload_time": "2024-03-23T09:34:55",
            "upload_time_iso_8601": "2024-03-23T09:34:55.814968Z",
            "url": "https://files.pythonhosted.org/packages/18/db/da4ec828b4de61b64a07e18e87b93a840df2f0ee279766d3d4efcf5b8850/stock_analysis_program-1.0.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9494bd9acdd0bafd85e7df4f1a44f9cee73714c4619cc5bb92c177488dda80e9",
                "md5": "93fcbf64dfd6621cf14d1db05613753d",
                "sha256": "9980dbd17607d8fec92f32cc38640d9216e0c3db04afddf07c99b3f04387912a"
            },
            "downloads": -1,
            "filename": "stock_analysis_program-1.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "93fcbf64dfd6621cf14d1db05613753d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 12321,
            "upload_time": "2024-03-23T09:34:56",
            "upload_time_iso_8601": "2024-03-23T09:34:56.972462Z",
            "url": "https://files.pythonhosted.org/packages/94/94/bd9acdd0bafd85e7df4f1a44f9cee73714c4619cc5bb92c177488dda80e9/stock_analysis_program-1.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-23 09:34:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "visionary-code-works",
    "github_project": "stock-analysis-program",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "pandas",
            "specs": [
                [
                    ">=",
                    "1.0"
                ]
            ]
        },
        {
            "name": "numpy",
            "specs": [
                [
                    ">=",
                    "1.18"
                ]
            ]
        },
        {
            "name": "matplotlib",
            "specs": [
                [
                    ">=",
                    "3.2"
                ]
            ]
        },
        {
            "name": "yfinance",
            "specs": []
        }
    ],
    "lcname": "stock-analysis-program"
}
Thaddeus Thomas
Elapsed time: 4.12812s