Skip to content

Commit 09e7902

Browse files
thomasthaddeusthomasthaddeus
authored
Merge pull request #14 from Visionary-Code-Works/dev
Dev
2 parents bef4f84 + 2bcb268 commit 09e7902

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

‎docs/Fetcher.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ The `fetcher` package is designed for financial data retrieval and analysis. It
2020

2121
| Class / Initialization | Description | Methods |
2222
| ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23-
| 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. |
24-
| 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. |
25-
| 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. |
23+
| 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. |
24+
| 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. |
25+
| 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. |
2626
| 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. |
2727

2828
---

‎pyproject.toml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
[tool.poetry]
22
name = "stock-analysis-program"
3-
version = "1.0.7"
3+
version = "1.0.8"
44
description = "A Python-based toolkit for fetching and visualizing financial data and metrics for stocks."
5+
readme = "README.md"
56
authors = [
67
"Thaddeus Thomas <thaddeus.r.thomas@gmail.com>",
78
"Fernando McKenzie <fernando.a.mckenzie@live.com>"

0 commit comments

Comments
 (0)