diff --git a/docs/Fetcher.md b/docs/Fetcher.md index ce4a76f..5f8bbeb 100644 --- a/docs/Fetcher.md +++ b/docs/Fetcher.md @@ -20,9 +20,9 @@ The `fetcher` package is designed for financial data retrieval and analysis. It | Class / Initialization | Description | Methods | | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| FinancialMetricsFetcher
`FinancialMetricsFetcher(tickers)` | Retrieves important financial metrics for a list of stock tickers, including:
market capitalization, P/E ratio, forward P/E, price to book ratio, and profit margins.
Ideal for financial analysis and comparisons across different stocks. | **`fetch_financial_metrics`**: Fetches and compiles financial metrics for each ticker in the list.
    **Returns**
    - `pandas.DataFrame`: A DataFrame containing the financial metrics for each ticker. | -| RevenueGrowthFetcher
`RevenueGrowthFetcher(tickers)` | Fetches and calculates the year-over-year revenue growth for a list of stock tickers.
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.
    **Returns**
    - `dict`: A dictionary with tickers as keys and their respective year-over-year revenue growth percentages as values. | -| StockDataFetcher
`StockDataFetcher(ticker)` | Fetches various types of stock data, including: historical data, moving averages,
average trading volume, and key financial metrics. | **`fetch_historical_data`**: Retrieves historical stock data for the specified period.
    **Parameters**
    - `period` (str, optional): The time period for which to fetch the data. Defaults to '1y'.
    **Returns**
    - `pandas.DataFrame`: Historical stock data.

**`calculate_moving_averages`**: Calculates moving averages for given window sizes.

**`get_average_volume`**: Calculates the average trading volume.

**`get_financial_metrics`**: Fetches and returns key financial metrics. | +| FinancialMetricsFetcher
`FinancialMetricsFetcher(tickers)` | Retrieves important financial metrics for a list of stock tickers, including:
market capitalization, P/E ratio, forward P/E, price to book ratio, and profit margins.
Ideal for financial analysis and comparisons across different stocks. | **`fetch_financial_metrics`**: Fetches and compiles financial metrics for each ticker in the list.
    **Returns**
    - `pandas.DataFrame`: A DataFrame containing the financial metrics for each ticker. | +| RevenueGrowthFetcher
`RevenueGrowthFetcher(tickers)` | Fetches and calculates the year-over-year revenue growth for a list of stock tickers.
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.
    **Returns**
    - `dict`: A dictionary with tickers as keys and their respective year-over-year revenue growth percentages as values. | +| StockDataFetcher
`StockDataFetcher(ticker)` | Fetches various types of stock data, including: historical data, moving averages,
average trading volume, and key financial metrics. | **`fetch_historical_data`**: Retrieves historical stock data for the specified period.
    **Parameters**
    - `period` (str, optional): The time period for which to fetch the data. Defaults to '1y'.
    **Returns**
    - `pandas.DataFrame`: Historical stock data.

**`calculate_moving_averages`**: Calculates moving averages for given window sizes.

**`get_average_volume`**: Calculates the average trading volume.

**`get_financial_metrics`**: Fetches and returns key financial metrics. | | StockSummaryFetcher
`StockSummaryFetcher(tickers)` | Fetches and provides summary information for a list of stock tickers, including:
company name, sector, industry, and key financial metrics. | **`fetch_summary`**: Fetches summary information for a given stock ticker.
    **Parameters**
    - `ticker` (str): The stock ticker.
    **Returns**
    - `dict`: Summary information of the stock.

**`get_summaries`**: Retrieves stock summaries for all tickers specified during initialization.
    **Returns**
    - `list of dict`: Summaries for each stock ticker. | --- diff --git a/pyproject.toml b/pyproject.toml index db797ee..04fa42d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 ", "Fernando McKenzie "