Skip to content

Dev #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thomasthaddeus merged 2 commits into from
Mar 23, 2024
Merged

Dev #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5afc4e6
fix minor errors
thomasthaddeus Mar 23, 2024
2bcb268
Merge pull request #13 from Visionary-Code-Works/main
thomasthaddeus Mar 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/Fetcher.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ The `fetcher` package is designed for financial data retrieval and analysis. It

| Class / Initialization | Description | Methods |
| ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| FinancialMetricsFetcher </br> `FinancialMetricsFetcher(tickers)` | Retrieves important financial metrics for a list of stock tickers, including:<br> market capitalization, P/E ratio, forward P/E, price to book ratio, and profit margins.<br> Ideal for financial analysis and comparisons across different stocks. | **`fetch_financial_metrics`**: Fetches and compiles financial metrics for each ticker in the list.<br>&nbsp;&nbsp;&nbsp;&nbsp;**Returns**<br>&nbsp;&nbsp;&nbsp;&nbsp;- `pandas.DataFrame`: A DataFrame containing the financial metrics for each ticker. |
| RevenueGrowthFetcher </br> `RevenueGrowthFetcher(tickers)` | Fetches and calculates the year-over-year revenue growth for a list of stock tickers.<br> Utilizes historical financial data to assess company performance over time. | **`fetch_revenue_growth`**: Calculates the most recent year-over-year revenue growth for each ticker.<br>&nbsp;&nbsp;&nbsp;&nbsp;**Returns**<br>&nbsp;&nbsp;&nbsp;&nbsp;- `dict`: A dictionary with tickers as keys and their respective year-over-year revenue growth percentages as values. |
| StockDataFetcher </br> `StockDataFetcher(ticker)` | Fetches various types of stock data, including: historical data, moving averages,<br> average trading volume, and key financial metrics. | **`fetch_historical_data`**: Retrieves historical stock data for the specified period.<br>&nbsp;&nbsp;&nbsp;&nbsp;**Parameters**<br>&nbsp;&nbsp;&nbsp;&nbsp;- `period` (str, optional): The time period for which to fetch the data. Defaults to '1y'.<br>&nbsp;&nbsp;&nbsp;&nbsp;**Returns**<br>&nbsp;&nbsp;&nbsp;&nbsp;- `pandas.DataFrame`: Historical stock data.<br><br>**`calculate_moving_averages`**: Calculates moving averages for given window sizes.<br><br>**`get_average_volume`**: Calculates the average trading volume.<br><br>**`get_financial_metrics`**: Fetches and returns key financial metrics. |
| FinancialMetricsFetcher <br> `FinancialMetricsFetcher(tickers)` | Retrieves important financial metrics for a list of stock tickers, including:<br> market capitalization, P/E ratio, forward P/E, price to book ratio, and profit margins.<br> Ideal for financial analysis and comparisons across different stocks. | **`fetch_financial_metrics`**: Fetches and compiles financial metrics for each ticker in the list.<br>&nbsp;&nbsp;&nbsp;&nbsp;**Returns**<br>&nbsp;&nbsp;&nbsp;&nbsp;- `pandas.DataFrame`: A DataFrame containing the financial metrics for each ticker. |
| RevenueGrowthFetcher <br> `RevenueGrowthFetcher(tickers)` | Fetches and calculates the year-over-year revenue growth for a list of stock tickers.<br> Utilizes historical financial data to assess company performance over time. | **`fetch_revenue_growth`**: Calculates the most recent year-over-year revenue growth for each ticker.<br>&nbsp;&nbsp;&nbsp;&nbsp;**Returns**<br>&nbsp;&nbsp;&nbsp;&nbsp;- `dict`: A dictionary with tickers as keys and their respective year-over-year revenue growth percentages as values. |
| StockDataFetcher <br> `StockDataFetcher(ticker)` | Fetches various types of stock data, including: historical data, moving averages,<br> average trading volume, and key financial metrics. | **`fetch_historical_data`**: Retrieves historical stock data for the specified period.<br>&nbsp;&nbsp;&nbsp;&nbsp;**Parameters**<br>&nbsp;&nbsp;&nbsp;&nbsp;- `period` (str, optional): The time period for which to fetch the data. Defaults to '1y'.<br>&nbsp;&nbsp;&nbsp;&nbsp;**Returns**<br>&nbsp;&nbsp;&nbsp;&nbsp;- `pandas.DataFrame`: Historical stock data.<br><br>**`calculate_moving_averages`**: Calculates moving averages for given window sizes.<br><br>**`get_average_volume`**: Calculates the average trading volume.<br><br>**`get_financial_metrics`**: Fetches and returns key financial metrics. |
| StockSummaryFetcher </br> `StockSummaryFetcher(tickers)` | Fetches and provides summary information for a list of stock tickers, including:<br> company name, sector, industry, and key financial metrics. | **`fetch_summary`**: Fetches summary information for a given stock ticker.<br>&nbsp;&nbsp;&nbsp;&nbsp;**Parameters**<br>&nbsp;&nbsp;&nbsp;&nbsp;- `ticker` (str): The stock ticker.<br>&nbsp;&nbsp;&nbsp;&nbsp;**Returns**<br>&nbsp;&nbsp;&nbsp;&nbsp;- `dict`: Summary information of the stock.<br><br>**`get_summaries`**: Retrieves stock summaries for all tickers specified during initialization.<br>&nbsp;&nbsp;&nbsp;&nbsp;**Returns**<br>&nbsp;&nbsp;&nbsp;&nbsp;- `list of dict`: Summaries for each stock ticker. |

---
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[tool.poetry]
name = "stock-analysis-program"
version = "1.0.7"
version = "1.0.8"
description = "A Python-based toolkit for fetching and visualizing financial data and metrics for stocks."
readme = "README.md"
authors = [
"Thaddeus Thomas <thaddeus.r.thomas@gmail.com>",
"Fernando McKenzie <fernando.a.mckenzie@live.com>"
Expand Down