financedatabase 2.2.2__tar.gz → 2.2.3__tar.gz

{financedatabase-2.2.2 → financedatabase-2.2.3}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: financedatabase
-Version: 2.2.2
+Version: 2.2.3
 Summary: This is a database of 300.000+ symbols containing Equities, ETFs, Funds, Indices, Currencies, Cryptocurrencies and Money Markets.
 Home-page: https://www.jeroenbouma.com/
 License: MIT
 Author: Jeroen Bouma
-Requires-Python: >=3.10,<3.13
+Requires-Python: >=3.10,<3.14
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Financial and Insurance Industry
 Classifier: License :: OSI Approved :: MIT License
@@ -15,8 +15,9 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Office/Business :: Financial :: Investment
-Requires-Dist: financetoolkit (>=1,<2)
-Requires-Dist: pandas[computation,performance,plot] (>=2.1.0,<3.0.0)
+Provides-Extra: financetoolkit
+Requires-Dist: financetoolkit ; extra == "financetoolkit"
+Requires-Dist: pandas[computation,excel,performance,plot] (>=2.2,<3.0)
 Project-URL: Repository, https://github.com/JerBouma/FinanceDatabase
 Description-Content-Type: text/markdown
 
@@ -24,7 +25,6 @@ Description-Content-Type: text/markdown
 
 [![GitHub Sponsors](https://img.shields.io/badge/Sponsor_this_Project-grey?logo=github)](https://github.com/sponsors/JerBouma)
 [![Buy Me a Coffee](https://img.shields.io/badge/Buy_Me_a_Coffee-grey?logo=buymeacoffee)](https://www.buymeacoffee.com/jerbouma)
-[![Twitter](https://img.shields.io/badge/Twitter-grey?logo=x)](https://twitter.com/JerBouma)
 [![LinkedIn](https://img.shields.io/badge/LinkedIn-grey?logo=Linkedin&logoColor=white)](https://www.linkedin.com/in/boumajeroen/)
 [![Documentation](https://img.shields.io/badge/Documentation-grey?logo=readme)](https://www.jeroenbouma.com/projects/financedatabase)
 [![Supported Python Versions](https://img.shields.io/pypi/pyversions/financedatabase)](https://pypi.org/project/financedatabase/)
@@ -59,8 +59,6 @@ Some key statistics of the database:
 
 The Finance Database is used within or referenced by:
 
-<a href="https://openbb.co/"><img width="200" height="100" alt="OpenBB" src="https://github-production-user-asset-6210df.s3.amazonaws.com/46355364/265290693-cff58802-8f6e-48ec-9a5c-1a7795c3522c.png"></a>
-<a href="https://app.noteable.io/f/242bc47d-9c85-4a30-b6e5-d7d201f6e2d6/Finance+Database.ipynb"><img alt="Noteable" width="200" height="100" src="https://github-production-user-asset-6210df.s3.amazonaws.com/46355364/265290704-1110feb5-3ad8-4f1c-b580-df661df4682d.png"></a>
 <a href="https://algotrading101.com/learn/financedatabase-python-guide/"><img width="200" height="100" alt="AlgoTrading" src="https://github-production-user-asset-6210df.s3.amazonaws.com/46355364/265290727-4c113348-45fc-45fe-afb5-e043b738ee94.png"></a>
 <a href="https://twitter.com/pyquantnews/status/1576185955677077504?lang=en"><img width="200" height="100" alt="PyQuantNews" src="https://github-production-user-asset-6210df.s3.amazonaws.com/46355364/265290754-8c9025fb-3830-4f41-95fd-e5e6d0f84758.png"></a>
 <a href="https://alpha2phi.medium.com/investment-analysis-finance-database-61f47ecfe7ca"><img width="200" height="100" alt="Medium" src="https://github-production-user-asset-6210df.s3.amazonaws.com/46355364/265290765-dfbd0f4c-85eb-4de6-adba-345cb5189f31.png"></a>
@@ -606,10 +604,8 @@ This section is meant to thank those that contributed to the project. Looking to
 If you have any questions about the FinanceDatabase or would like to share with me what you have been working on, feel free to reach out to me via:
 
 - **Website**: https://jeroenbouma.com/
-- **Twitter**: https://twitter.com/JerBouma
 - **LinkedIn:** https://www.linkedin.com/in/boumajeroen/
 - **Email:** jer.bouma@gmail.com
-- **Discord:** add me on Discord **`JerBouma`**
 
 f you'd like to support my efforts, either help me out via the [Contributing Guidelines](https://github.com/JerBouma/FinanceDatabase/blob/main/CONTRIBUTING.md) or [Buy me a Coffee](https://www.buymeacoffee.com/jerbouma).
 

{financedatabase-2.2.2 → financedatabase-2.2.3}/README.md

@@ -2,7 +2,6 @@
 
 [![GitHub Sponsors](https://img.shields.io/badge/Sponsor_this_Project-grey?logo=github)](https://github.com/sponsors/JerBouma)
 [![Buy Me a Coffee](https://img.shields.io/badge/Buy_Me_a_Coffee-grey?logo=buymeacoffee)](https://www.buymeacoffee.com/jerbouma)
-[![Twitter](https://img.shields.io/badge/Twitter-grey?logo=x)](https://twitter.com/JerBouma)
 [![LinkedIn](https://img.shields.io/badge/LinkedIn-grey?logo=Linkedin&logoColor=white)](https://www.linkedin.com/in/boumajeroen/)
 [![Documentation](https://img.shields.io/badge/Documentation-grey?logo=readme)](https://www.jeroenbouma.com/projects/financedatabase)
 [![Supported Python Versions](https://img.shields.io/pypi/pyversions/financedatabase)](https://pypi.org/project/financedatabase/)
@@ -37,8 +36,6 @@ Some key statistics of the database:
 
 The Finance Database is used within or referenced by:
 
-<a href="https://openbb.co/"><img width="200" height="100" alt="OpenBB" src="https://github-production-user-asset-6210df.s3.amazonaws.com/46355364/265290693-cff58802-8f6e-48ec-9a5c-1a7795c3522c.png"></a>
-<a href="https://app.noteable.io/f/242bc47d-9c85-4a30-b6e5-d7d201f6e2d6/Finance+Database.ipynb"><img alt="Noteable" width="200" height="100" src="https://github-production-user-asset-6210df.s3.amazonaws.com/46355364/265290704-1110feb5-3ad8-4f1c-b580-df661df4682d.png"></a>
 <a href="https://algotrading101.com/learn/financedatabase-python-guide/"><img width="200" height="100" alt="AlgoTrading" src="https://github-production-user-asset-6210df.s3.amazonaws.com/46355364/265290727-4c113348-45fc-45fe-afb5-e043b738ee94.png"></a>
 <a href="https://twitter.com/pyquantnews/status/1576185955677077504?lang=en"><img width="200" height="100" alt="PyQuantNews" src="https://github-production-user-asset-6210df.s3.amazonaws.com/46355364/265290754-8c9025fb-3830-4f41-95fd-e5e6d0f84758.png"></a>
 <a href="https://alpha2phi.medium.com/investment-analysis-finance-database-61f47ecfe7ca"><img width="200" height="100" alt="Medium" src="https://github-production-user-asset-6210df.s3.amazonaws.com/46355364/265290765-dfbd0f4c-85eb-4de6-adba-345cb5189f31.png"></a>
@@ -584,10 +581,8 @@ This section is meant to thank those that contributed to the project. Looking to
 If you have any questions about the FinanceDatabase or would like to share with me what you have been working on, feel free to reach out to me via:
 
 - **Website**: https://jeroenbouma.com/
-- **Twitter**: https://twitter.com/JerBouma
 - **LinkedIn:** https://www.linkedin.com/in/boumajeroen/
 - **Email:** jer.bouma@gmail.com
-- **Discord:** add me on Discord **`JerBouma`**
 
 f you'd like to support my efforts, either help me out via the [Contributing Guidelines](https://github.com/JerBouma/FinanceDatabase/blob/main/CONTRIBUTING.md) or [Buy me a Coffee](https://www.buymeacoffee.com/jerbouma).
 

{financedatabase-2.2.2 → financedatabase-2.2.3}/financedatabase/__init__.py

@@ -1,4 +1,5 @@
 """Init Module"""
+
 from .helpers import obtain_options  # noqa
 from .Cryptos import Cryptos  # noqa
 from .Currencies import Currencies  # noqa

{financedatabase-2.2.2 → financedatabase-2.2.3}/financedatabase/helpers.py

@@ -3,7 +3,6 @@
 from pathlib import Path
 
 import pandas as pd
-from financetoolkit import Toolkit
 
 file_path = Path(__file__).parent.parent / "compression"
 DATA_REPO = (
@@ -127,13 +126,17 @@ class FinanceFrame(pd.DataFrame):
         start_date: str | None = None,
         end_date: str | None = None,
         quarterly: bool = False,
+        use_cached_data: bool | str = False,
         risk_free_rate: str = "10y",
         benchmark_ticker: str | None = "SPY",
+        historical_source: str | None = None,
+        convert_currency: bool | None = None,
+        intraday_period: str | None = None,
         rounding: int | None = 4,
         remove_invalid_tickers: bool = False,
         sleep_timer: bool | None = None,
         progress_bar: bool = True,
-    ) -> Toolkit:
+    ):
         """
         Convert the FinanceFrame to a Finance Toolkit object.
 
@@ -142,7 +145,11 @@ class FinanceFrame(pd.DataFrame):
         performance and risk metrics, models, and technical indicators.
 
         Args:
-            api_key (str): An API key from FinancialModelingPrep. Obtain one here: https://www.jeroenbouma.com/fmp
+            tickers (str or list): A string or a list of strings containing the company ticker(s). E.g. 'TSLA' or 'MSFT'
+            Find the tickers on a variety of websites or via the FinanceDatabase:
+            https://github.com/JerBouma/financedatabase
+            api_key (str): An API key from FinancialModelingPrep. Obtain one here:
+            https://www.jeroenbouma.com/fmp
             start_date (str): A string containing the start date of the data. This needs to be formatted as YYYY-MM-DD.
                 The default is today minus 10 years which can be freely changed to extend the period.
             end_date (str): A string containing the end date of the data. This needs to be formatted as YYYY-MM-DD.
@@ -150,11 +157,29 @@ class FinanceFrame(pd.DataFrame):
             quarterly (bool): A boolean indicating whether to collect quarterly data. This defaults to False and thus
             collects yearly financial statements. Note that historical data can still be collected for
             any period and interval.
+            use_cached_data (bool or str): A boolean indicating whether to use cached data. This is useful when you
+            have collected data before and want to use this data again. If you want to use a specific location to
+            store the cached data, you can define this as a string, e.g. "datasets". Defaults to False.
             risk_free_rate (str): A string containing the risk free rate. This can be 13w, 5y, 10y or 30y. This is
             based on the US Treasury Yields and is used to calculate various ratios and Excess Returns.
             benchmark_ticker (str): A string containing the benchmark ticker. Defaults to SPY (S&P 500). This is
             meant to calculate ratios and indicators such as the CAPM and Jensen's Alpha but also serves as purpose to
             give insights in the performance of a stock compared to a benchmark.
+            historical_source (str): A string containing the historical source. This can be either FinancialModelingPrep
+            or YahooFinance. Defaults to FinancialModelingPrep. It is automatically defined if you enter an API Key from
+            FinancialModelingPrep. You can overwrite this by filling this parameter. Note that for the Free plan
+            the amount of historical data is limited to 5 years. If you want to collect more data, you need to
+            upgrade to a paid plan.
+            convert_currency (bool): A boolean indicating whether to convert the currency of the financial statements to
+            match that of the related historical data. This is an important conversion when comparing the financial
+            statements between each ticker as well as for calculations that are done with the historical data.
+                If you are using a Free plan from FinancialModelingPrep, this will be set to False.
+                If you are using a Premium plan from FinancialModelingPrep, this will be set to True. Defaults to None
+            and can thus be overridden.
+            intraday_period (str): A string containing the intraday period. This can be 1min, 5min, 15min, 30min or 1hour.
+            This is used to collect intraday data. Note that this is only relevant if you have are looking to utilize
+            intraday data through the Toolkit and wish to access Risk, Performance and Technicals for very short
+            timeframes. Defaults to None which means it will not use intraday data.
             rounding (int): An integer indicating the number of decimals to round the results to.
             remove_invalid_tickers (bool): A boolean indicating whether to remove invalid tickers. Defaults to False.
             sleep_timer (bool): Whether to set a sleep timer when the rate limit is reached. Note that this only works
@@ -166,6 +191,13 @@ class FinanceFrame(pd.DataFrame):
             Toolkit:
                 A Finance Toolkit object.
         """
+        try:
+            from financetoolkit import Toolkit
+        except ImportError:
+            raise ImportError(
+                "To use the 'to_toolkit' functionality, it requires installation of the FinanceToolkit "
+                "Please use: \033[1m pip install 'financedatabase[financetoolkit]' \033[0m"
+            )
         if api_key is None:
             print(
                 "The parameter api_key is not set. Therefore, only historical data and "
@@ -183,8 +215,12 @@ class FinanceFrame(pd.DataFrame):
             start_date=start_date,
             end_date=end_date,
             quarterly=quarterly,
+            use_cached_data=use_cached_data,
             risk_free_rate=risk_free_rate,
             benchmark_ticker=benchmark_ticker,
+            historical_source=historical_source,
+            convert_currency=convert_currency,
+            intraday_period=intraday_period,
             rounding=rounding,
             remove_invalid_tickers=remove_invalid_tickers,
             sleep_timer=sleep_timer,

{financedatabase-2.2.2 → financedatabase-2.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "financedatabase"
-version = "2.2.2"
+version = "2.2.3"
 description = "This is a database of 300.000+ symbols containing Equities, ETFs, Funds, Indices, Currencies, Cryptocurrencies and Money Markets."
 license = "MIT"
 authors = ["Jeroen Bouma"]
@@ -22,15 +22,15 @@ classifiers = [
 ]
 
 [tool.poetry.dependencies]
-python = ">=3.10, <3.13"
-financetoolkit = "^1"
-pandas = {extras = ["computation", "performance", "plot"], version = "^2.1.0"}
+python = ">=3.10, <3.14"
+financetoolkit = { version = "*", optional = true }
+pandas = {version = "^2.2", extras = ["computation", "performance", "plot", "excel"]}
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^6.2.2"
 pylint = "2.17.0"
 codespell = "^2.2.4"
-black = "^23.1.0"
+black = ">=23.1,<25.0"
 bandit = "^1.7.0"
 pytest-mock = "^3.6.1"
 pytest-recording = "^0.12.0"
@@ -39,6 +39,9 @@ ruff = "^0.0.256"
 pytest-timeout = "^2.1.0"
 pytest-recorder = "^0.2.1"
 
+[tool.poetry.extras]
+financetoolkit = ["financetoolkit"]
+
 [build-system]
 requires = ["setuptools<65.5.0", "poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
@@ -46,7 +49,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.ruff]
 line-length = 122
 select = ["E", "W", "F", "Q", "W", "S", "UP", "I", "PD", "SIM", "PLC", "PLE", "PLR", "PLW"]
-ignore = ["S105", "S106", "S107", "PLR0913"]
+ignore = ["S105", "S106", "S107", "PLR0913", "PLR0912", "PLR0915"]
 
 [tool.pylint]
 max-line-length = 122