kensho-kfinance 2.4.3__py3-none-any.whl → 2.6.2__py3-none-any.whl

{kensho_kfinance-2.4.3.dist-info → kensho_kfinance-2.6.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.4.3
+Version: 2.6.2
 Summary: Python CLI for kFinance
 Author-email: Luke Brown <luke.brown@kensho.com>, Michelle Keoy <michelle.keoy@kensho.com>, Keith Page <keith.page@kensho.com>, Matthew Rosen <matthew.rosen@kensho.com>, Nick Roshdieh <nick.roshdieh@kensho.com>
 Project-URL: source, https://github.com/kensho-technologies/kfinance
@@ -27,7 +27,7 @@ Requires-Dist: strenum>=0.4.15
 Requires-Dist: tabulate>=0.9.0
 Requires-Dist: types-requests<3,>=2.22.0
 Requires-Dist: requests<3,>=2.22.0
-Requires-Dist: urllib3>=1.21.1
+Requires-Dist: urllib3>=2.5
 Provides-Extra: dev
 Requires-Dist: coverage<8,>=7.6.10; extra == "dev"
 Requires-Dist: ipykernel<7,>=6.29; extra == "dev"
@@ -67,11 +67,11 @@ Once access is obtained, get started using the [Authentication Guide](https://do
 To get started, we provide some notebooks:
 
 - The [LLM-ready API Basic Usage](example_notebooks%2Fbasic_usage.ipynb) notebook demonstrates how
-fetch data with the kFinance client.
+  fetch data with the kFinance client.
 - The [tool_calling notebooks](example_notebooks%2Ftool_calling) show how the kFinance library can
-be used for tool calling. We provide notebooks for OpenAI (GPT), Anthropic (Claude), and Google
+  be used for tool calling. We provide notebooks for OpenAI (GPT), Anthropic (Claude), and Google
   (Gemini). Each of these integrations comes in a langchain version, which uses langchain as a
-wrapper to simplify the integration, and as a lower level non-langchain version.
+  wrapper to simplify the integration, and as a lower level non-langchain version.
 
 We also provide an [interactive notebook](example_notebooks/basic_usage.ipynb) that demonstrates some usage examples.
 
@@ -88,15 +88,48 @@ The server's full signature is as follows:
 `kfinance.mcp [--stdio,-s]/[--sse, ] --refresh-token <refresh-token> --client-id <client-id> --private-key <private-key>`
 
 Authentication Methods (in order of precedence):
+
 1. Refresh Token: Uses an existing refresh token for authentication. The `--refresh-token <refresh-token>` argument must be provided.
 2. Key Pair: Uses client ID and private key for authentication. Both the `--client-id <client-id>` and `--private-key <private-key>` arguments must be provided.
 3. Browser: Falls back to browser-based authentication flow. This occurs if no auth arguments are provided.
 
 Transport Layers:
+
 - stdio can be set by passing either `--stdio` or `-s`
 - sse can be set by passing `--sse` or no other transport related flag
 
+# Development
+
+## Working with Local Package Version
+
+If you need to develop using a local version of the kFinance package in another project that uses [poetry](https://python-poetry.org/) for package and dependency management, follow these steps:
+
+1. In your dependent project's `pyproject.toml`, replace the kFinance package version specification:
+
+   ```toml
+   # Replace this:
+   # kensho-kfinance = "~2.0.1"
+   # With this:
+   kensho-kfinance = { path = "/absolute/path/to/kfinance", develop = true }
+   ```
+
+   The `develop = true` flag ensures that the package always matches your local version without requiring reinstallation after changes.
+
+2. Update your project's dependencies:
+
+   ```bash
+   poetry update    # Update poetry.lock with new changes
+   poetry install   # Install dependencies with updated configuration
+   ```
+
+   If you encounter the error "your pyproject.toml file has significantly changed", run:
+
+   ```bash
+   poetry lock     # Sync the changes to poetry.lock
+   ```
+
 # Versioning
+
 The kFinance uses semantic versioning (major, minor, patch).
 To bump the version, add a new entry in [CHANGELOG.md](kfinance%2FCHANGELOG.md).
 This will generate a new version of the library as part of the release process.

{kensho_kfinance-2.4.3.dist-info → kensho_kfinance-2.6.2.dist-info}/RECORD

@@ -1,35 +1,36 @@
-kensho_kfinance-2.4.3.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
-kensho_kfinance-2.4.3.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
-kfinance/CHANGELOG.md,sha256=2EpxIzLz1uuod_1rJk6xxGLW_Y2-kupUSWJsREi4esI,1578
+kensho_kfinance-2.6.2.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
+kensho_kfinance-2.6.2.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
+kfinance/CHANGELOG.md,sha256=ndCVbkomHlJ7kB7FoNB3N17A97hrPPtu02dxh-JBdJA,1927
 kfinance/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/batch_request_handling.py,sha256=p6p_G4_BL06GgeKlh7P1k9CUqOMahWCLEw1NoBwbLvU,5698
-kfinance/constants.py,sha256=vVE_WlLNUKBn85eL8QBnk_zUSNDBRLcWutaQy-5wvGA,48768
-kfinance/fetch.py,sha256=yLqKMYYP5MwHhRZBuY_ihudHeSpNvzA8u1meYrEYX90,23923
-kfinance/kfinance.py,sha256=9lcarUW4fLHJA_U7_1ihCMbNJWs0AztvKf_XEd0qupk,59889
+kfinance/batch_request_handling.py,sha256=G9rhpgQaCdb5C1dsfuJip8383iszibcOJ5k8gxld-tQ,5001
+kfinance/constants.py,sha256=jaHsTXEmGKLp55x1_ob_MA-GVn_hua5B6RZCbujKWz0,49401
+kfinance/fetch.py,sha256=QyQjL2t9Z_tT1DD_Xzal59URH7QtnrpLQywcHSFtoWA,26691
+kfinance/kfinance.py,sha256=WNw6hR7eIKVFM5iBtGrArJcOowange_ed5_PAc0aLzE,72768
 kfinance/mcp.py,sha256=MbktclVfBOEwfe-eR7kPaTXopMJmn_8RMlf4Jx5CXKU,3689
-kfinance/meta_classes.py,sha256=3V0nSXDDoake5o7kXnrqXuqNIiwI75KR4IYxFqSPhTE,20736
+kfinance/meta_classes.py,sha256=bUkksl5a9NkQQWmSM2XIWP3jsmmP4ZAfvSxPW5tRZg4,21492
 kfinance/prompt.py,sha256=PtVB8c_FcSlVdyGgByAnIFGzuUuBaEjciCqnBJl1hSQ,25133
 kfinance/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/pydantic_models.py,sha256=avpbPqwrAyLqsCbrmFpK_B8_fj1nPlBHrnPxRcBaSkE,774
 kfinance/server_thread.py,sha256=jUnt1YGoYDkqqz1MbCwd44zJs1T_Z2BCgvj75bdtLgA,2574
-kfinance/version.py,sha256=xLAVxNld0iPK6tqrofzfozu9ZHg4aby5Rg0HcLuAYIU,511
+kfinance/version.py,sha256=0Bv8KyeMcw-iHj2UIKRw0oUzwjzKa7KzZIuWroBAK1A,511
 kfinance/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/tests/conftest.py,sha256=voB-w8P_6L3Nel3rdgylXKe5WWaS1q7nCFt1O04uqoY,948
+kfinance/tests/conftest.py,sha256=dhL_RSc-af3j-2_UrAGRE9mxgcbjuIRtj08DTx79pQc,1123
 kfinance/tests/scratch.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/tests/test_batch_requests.py,sha256=uXJF2IcRdyBm5SthwIUHMKtkGZ21MY84pg_k1JeSNOY,11430
+kfinance/tests/test_batch_requests.py,sha256=2A0XnDDDSPkq0-BuiRryZx8b9_jBDtjYd2kWxFVyRew,10140
 kfinance/tests/test_client.py,sha256=O7icZCSDhlQ9WGhzoXlpiSvbuA-mQNJHBYVsilyP_dE,2209
 kfinance/tests/test_example_notebook.py,sha256=XHwDKw2avyMonTmi3snCcFWNfZhEJOkpBGOZNrMLrhk,6470
-kfinance/tests/test_fetch.py,sha256=nfnz_ZxE-W3KMzpDaRClX55fQJrRjwLTha-rHTallmE,16713
+kfinance/tests/test_fetch.py,sha256=mIj61dd843p3D1qtTAO60rZi6Rax0NgefOTTiBFrQcQ,17887
 kfinance/tests/test_group_objects.py,sha256=SoMEZmkG4RYdgWOAwxLHHtzIQho92KM01YbQXPUg578,1689
-kfinance/tests/test_objects.py,sha256=0nDmCFrVcfI8VBo1Ph3YqXNo3uPLsSUiQkjEEHsax1M,30416
-kfinance/tests/test_tools.py,sha256=GMyReX2GBy_fozMZvA_yvZ6_bl1EPvJ2Eza9G5f4CEM,25753
+kfinance/tests/test_objects.py,sha256=YlpxjlT1kJsDf4SgTZkhhthODwCnwNukJF_wvi11p3A,40805
+kfinance/tests/test_tools.py,sha256=OfyoS4LInkh8c6hlGj-qtTwaL0WqV-8H7od3uNYXnec,29086
 kfinance/tool_calling/README.md,sha256=omJq7Us6r4U45QB7hRpLjRJ5BMalCkZkh4uXBjTbJXc,2022
-kfinance/tool_calling/__init__.py,sha256=V5BVcJkLT1zC0QKZIQjLb-cZiQYV4T9Egj64uH807WE,2215
+kfinance/tool_calling/__init__.py,sha256=UmtbtG6PvQHB1fInEL-K5q0kPHL__zTY9wzaPRSp1wg,2174
+kfinance/tool_calling/get_advisors_for_company_in_transaction_from_identifier.py,sha256=u9FNRiNYiwsFXuWJNOsaW8msMrAYqGcMp-blPG-cIfg,1607
 kfinance/tool_calling/get_business_relationship_from_identifier.py,sha256=CipXvyqEjPm6BXYP0CA9Kp1BIyiIEm7abp85x1zXRV4,1472
 kfinance/tool_calling/get_capitalization_from_identifier.py,sha256=TdWdJDeI-jSL-1YfhnnwIA9D1SXobidvoHrjK42QmqQ,1521
+kfinance/tool_calling/get_competitors_from_identifier.py,sha256=sCmimHZexWzvKE-13TOAErKKUoyBChxp9h_oa3W0Duo,1051
 kfinance/tool_calling/get_cusip_from_ticker.py,sha256=houhGCYXoSzaaTtCvOBf3pPsYiSbcV1Ej5nAyGuMWcU,644
 kfinance/tool_calling/get_earnings.py,sha256=7xavYvqwq4fO0vpks25eDM87bCYwZxEQSwgT0I8jAok,1165
-kfinance/tool_calling/get_earnings_call_datetimes_from_identifier.py,sha256=Zp7gHP-z2ePu484wWx4xw89hl0z7NLcG3qliJT-6rUo,782
 kfinance/tool_calling/get_financial_line_item_from_identifier.py,sha256=TgZCHOKwMVUc0c7k5RGN5FWfXEM9cmJXTrDWiGudad8,2153
 kfinance/tool_calling/get_financial_statement_from_identifier.py,sha256=QM3DfctPq8gMJzRZl508Qc184MWq_o6gwGNZEwbYopg,1906
 kfinance/tool_calling/get_history_metadata_from_identifier.py,sha256=kKIInfRC1Plf-Wnx9cmaJ46RRABm6zn3F5_8qAdqrBg,728
@@ -37,6 +38,8 @@ kfinance/tool_calling/get_info_from_identifier.py,sha256=PRhSYpYs_iUcIVFGYCMN_7Q
 kfinance/tool_calling/get_isin_from_ticker.py,sha256=2fJBcA-rNGbVOQmQ7qJEYxqejQwJ6nyWOBSFlzxG7dY,638
 kfinance/tool_calling/get_latest.py,sha256=btGeVBmvX5QJutzrKfE6spatGGejDuHxtq53NoAaGNk,786
 kfinance/tool_calling/get_latest_earnings.py,sha256=pQdExGdztGY3pHcak0bd6ULNf_ROPc91bJ7zAVSKQkk,1117
+kfinance/tool_calling/get_merger_info_from_transaction_id.py,sha256=8aMktxIs89czDRCn4o7LcUmoTO8ueUDI40nXHo6rNZY,3142
+kfinance/tool_calling/get_mergers_from_identifier.py,sha256=9tCaSrJsK3-i0ZDNKAJRhE-nRdJvQxTbrZbvVY0YmQw,1702
 kfinance/tool_calling/get_n_quarters_ago.py,sha256=A0ilwPKUqU0YYQSz3gNsVF0Jy4YttXrSaDhYj7y8GHA,713
 kfinance/tool_calling/get_next_earnings.py,sha256=knzQw-m-hscCvTuDUXG9v_dObKJBGn5BbDZWGKHKQcw,1097
 kfinance/tool_calling/get_prices_from_identifier.py,sha256=ViJkwLDvStB7grc8RuoKSDXQM399Wru4-OY3E8k1l_U,1882
@@ -45,7 +48,7 @@ kfinance/tool_calling/get_transcript.py,sha256=eB-IsRwD-mllsMOYRZbH35caQ1Y3teKft
 kfinance/tool_calling/prompts.py,sha256=Yw1DJIMh90cjL-8q6_RMRiSjCtFDXvJAy7QiV5_uAU8,911
 kfinance/tool_calling/resolve_identifier.py,sha256=npslr6bBCu0qEDV1-8d24F5OC3nQ1KBMphuMbHVC1AU,626
 kfinance/tool_calling/shared_models.py,sha256=loNoVFVyQnnpHLUIjkR6P9flGNbzp6kkGpL5hT37Sdg,2666
-kensho_kfinance-2.4.3.dist-info/METADATA,sha256=1Q6uTDsyuQqiSoEJ10HF83D5JHvupCBhyK0HobXrzyA,5191
-kensho_kfinance-2.4.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kensho_kfinance-2.4.3.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
-kensho_kfinance-2.4.3.dist-info/RECORD,,
+kensho_kfinance-2.6.2.dist-info/METADATA,sha256=gmrV13LppEUpW6KMJKZftWQz1UlN165RC-G5Uwpxts8,6197
+kensho_kfinance-2.6.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kensho_kfinance-2.6.2.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
+kensho_kfinance-2.6.2.dist-info/RECORD,,

kfinance/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+# v2.6.3
+- Bump urllib3 to 2.5 to  address CVEs
+
+## v2.6.2
+ - Safely check for incomplete merger information
+
+## v2.6.1
+ - Remove get_earnings_call_datetimes_from_identifier tool
+
+## v2.6.0
+ - Add mergers & acquisitions.
+
+## v2.5.0
+ - Add competitors function and llm tools
+
+## v2.4.4
+- Replace `cached_property` with `property` to enable batching
+
 ## v2.4.3
 - Improve MCP tool build process
 

kfinance/batch_request_handling.py

@@ -1,6 +1,5 @@
 from concurrent.futures import Future
 import functools
-from functools import cached_property
 import threading
 from typing import Any, Callable, Iterable, Protocol, Sized, Type, TypeVar
 
@@ -17,7 +16,7 @@ throttle = threading.Semaphore(MAX_WORKERS_CAP)
 
 
 def add_methods_of_singular_class_to_iterable_class(singular_cls: Type[T]) -> Callable:
-    """Returns a decorator that sets each method, property, and cached_property of"""
+    """Returns a decorator that adds methods and properties from a singular to a plural class."""
     "[singular_cls] as an attribute of the decorated class."
 
     class IterableKfinanceClass(Protocol, Sized, Iterable[T]):
@@ -32,7 +31,7 @@ def add_methods_of_singular_class_to_iterable_class(singular_cls: Type[T]) -> Ca
         """Adds functions from a singular class to an iterable class.
 
         This decorator modifies the [iterable_cls] so that when an attribute
-        (method, property, or cached property) added by the decorator is accessed,
+        (method or property) added by the decorator is accessed,
         it returns a dictionary. This dictionary maps each object in [iterable_cls]
         to the result of invoking the attribute on that specific object.
 
@@ -109,19 +108,6 @@ def add_methods_of_singular_class_to_iterable_class(singular_cls: Type[T]) -> Ca
 
                 setattr(iterable_cls, method_name, property(create_prop_wrapper(method)))
 
-            elif isinstance(method, cached_property):
-
-                def create_cached_prop_wrapper(method: cached_property) -> cached_property:
-                    @functools.wraps(method.func)
-                    def cached_prop_wrapper(self: IterableKfinanceClass) -> Any:
-                        return process_in_batch(method.func, self)
-
-                    wrapped_cached_property = cached_property(cached_prop_wrapper)
-                    wrapped_cached_property.__set_name__(iterable_cls, method_name)
-                    return wrapped_cached_property
-
-                setattr(iterable_cls, method_name, create_cached_prop_wrapper(method))
-
         return iterable_cls
 
     return decorator

kfinance/constants.py

@@ -101,6 +101,20 @@ class Permission(StrEnum):
     RelationshipPermission = "RelationshipPermission"
     StatementsPermission = "StatementsPermission"
     SegmentsPermission = "SegmentsPermission"
+    MergersPermission = "MergersPermission"
+    CompetitorsPermission = "CompetitorsPermission"
+
+
+class CompetitorSource(StrEnum):
+    """The source type of the competitor information: 'filing' (from SEC filings), 'key_dev' (from key developments), 'contact' (from contact relationships), 'third_party' (from third-party sources), 'self_identified' (self-identified), 'named_by_competitor' (from competitor's perspective)."""
+
+    all = "all"
+    filing = "filing"
+    key_dev = "key_dev"
+    contact = "contact"
+    third_party = "third_party"
+    self_identified = "self_identified"
+    named_by_competitor = "named_by_competitor"
 
 
 class YearAndQuarter(TypedDict):

kfinance/fetch.py

@@ -11,6 +11,7 @@ import requests
 
 from .constants import (
     BusinessRelationshipType,
+    CompetitorSource,
     IdentificationTriple,
     IndustryClassification,
     Periodicity,
@@ -577,3 +578,58 @@ class KFinanceApiClient:
         """Get the transcript for an earnings item."""
         url = f"{self.url_base}transcript/{key_dev_id}"
         return self.fetch(url)
+
+    def fetch_competitors(self, company_id: int, competitor_source: CompetitorSource) -> dict:
+        """Get the competitors for a company."""
+        url = f"{self.url_base}competitors/{company_id}"
+        if competitor_source is not CompetitorSource.all:
+            url = url + f"/{competitor_source}"
+        return self.fetch(url)
+
+    def fetch_mergers_for_company(
+        self,
+        company_id: int,
+    ) -> dict[str, list[dict[str, int | str]]]:
+        """Fetches the mergers and acquisitions the given company was involved in.
+
+        Returns a dictionary of shape {"target", [{"transaction_id": <transaction_id>, "merger_title": <merger short title>}], "buyer": [...], "seller": [...]}
+        :param company_id: The company ID to filter on.
+        :type company_id: int
+        :return: A dictionary containing transaction IDs and 'merger titles' for each of the three kinds of roles the given company could be party to.
+        :rtype: dict[str, list[dict[str, int | str]]]
+        """
+        url = f"{self.url_base}mergers/{company_id}"
+        return self.fetch(url)
+
+    def fetch_merger_info(
+        self,
+        transaction_id: int,
+    ) -> dict:
+        """Fetches information about the given merger or acquisition, including the timeline, the participants, and the considerations.
+
+        Returns a complex dictionary.
+        :param transaction_id: The transaction ID to filter on.
+        :type transaction_id: int
+        :return: A dictionary containing the timeline, the participants, and the considerations (eith their details) of the transaction.
+        :rtype: dict
+        """
+        url = f"{self.url_base}merger/info/{transaction_id}"
+        return self.fetch(url)
+
+    def fetch_advisors_for_company_in_merger(
+        self,
+        transaction_id: int,
+        advised_company_id: int,
+    ) -> dict[str, list[dict[str, int | str]]]:
+        """Fetch information about the advisors of a given company involved in a given merger or acquisition.
+
+        Returns a dictionary of shape {"advisors": [{"advisor_company_id": <advisor_company_id>, "advisor_company_name": <advisor_company_name>, "advisor_type_name": <advisor_type_name>},...]}
+        :param transaction_id: The transaction ID to filter on.
+        :type transaction_id: int
+        :param advised_company_id: The company ID involved with the transaction.
+        :type advised_company_id: int
+        :return: A dictionary containing the list of companies advising a company involved with a merger or acquisition, along with their advisor type.
+        :rtype: dict[str, list[dict[str, int | str]]]
+        """
+        url = f"{self.url_base}merger/info/{transaction_id}/advisors/{advised_company_id}"
+        return self.fetch(url)