kensho-kfinance 2.4.2__tar.gz → 2.6.1__tar.gz

{kensho_kfinance-2.4.2/kensho_kfinance.egg-info → kensho_kfinance-2.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.4.2
+Version: 2.6.1
 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

{kensho_kfinance-2.4.2 → kensho_kfinance-2.6.1/kensho_kfinance.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.4.2
+Version: 2.6.1
 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

{kensho_kfinance-2.4.2 → kensho_kfinance-2.6.1}/kensho_kfinance.egg-info/SOURCES.txt

@@ -48,21 +48,22 @@ kfinance/server_thread.py
 kfinance/version.py
 kfinance/tests/__init__.py
 kfinance/tests/conftest.py
+kfinance/tests/scratch.py
 kfinance/tests/test_batch_requests.py
 kfinance/tests/test_client.py
 kfinance/tests/test_example_notebook.py
 kfinance/tests/test_fetch.py
 kfinance/tests/test_group_objects.py
-kfinance/tests/test_mcp.py
 kfinance/tests/test_objects.py
 kfinance/tests/test_tools.py
 kfinance/tool_calling/README.md
 kfinance/tool_calling/__init__.py
+kfinance/tool_calling/get_advisors_for_company_in_transaction_from_identifier.py
 kfinance/tool_calling/get_business_relationship_from_identifier.py
 kfinance/tool_calling/get_capitalization_from_identifier.py
+kfinance/tool_calling/get_competitors_from_identifier.py
 kfinance/tool_calling/get_cusip_from_ticker.py
 kfinance/tool_calling/get_earnings.py
-kfinance/tool_calling/get_earnings_call_datetimes_from_identifier.py
 kfinance/tool_calling/get_financial_line_item_from_identifier.py
 kfinance/tool_calling/get_financial_statement_from_identifier.py
 kfinance/tool_calling/get_history_metadata_from_identifier.py
@@ -70,6 +71,8 @@ kfinance/tool_calling/get_info_from_identifier.py
 kfinance/tool_calling/get_isin_from_ticker.py
 kfinance/tool_calling/get_latest.py
 kfinance/tool_calling/get_latest_earnings.py
+kfinance/tool_calling/get_merger_info_from_transaction_id.py
+kfinance/tool_calling/get_mergers_from_identifier.py
 kfinance/tool_calling/get_n_quarters_ago.py
 kfinance/tool_calling/get_next_earnings.py
 kfinance/tool_calling/get_prices_from_identifier.py

{kensho_kfinance-2.4.2 → kensho_kfinance-2.6.1}/kfinance/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 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
+
 ## v2.4.2
 - Update missing permission warning
 

{kensho_kfinance-2.4.2 → kensho_kfinance-2.6.1}/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

{kensho_kfinance-2.4.2 → kensho_kfinance-2.6.1}/kfinance/constants.py

@@ -56,10 +56,8 @@ class StatementType(StrEnum):
     """The type of financial statement"""
 
     balance_sheet = "balance_sheet"
-    bs = "balance_sheet"
     income_statement = "income_statement"
     cashflow = "cashflow"
-    cf = "cashflow"
 
 
 class SegmentType(StrEnum):
@@ -103,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):

{kensho_kfinance-2.4.2 → kensho_kfinance-2.6.1}/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)