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

kfinance/tool_calling/__init__.py

@@ -4,11 +4,9 @@ from kfinance.tool_calling.get_business_relationship_from_identifier import (
     GetBusinessRelationshipFromIdentifier,
 )
 from kfinance.tool_calling.get_capitalization_from_identifier import GetCapitalizationFromIdentifier
+from kfinance.tool_calling.get_competitors_from_identifier import GetCompetitorsFromIdentifier
 from kfinance.tool_calling.get_cusip_from_ticker import GetCusipFromTicker
 from kfinance.tool_calling.get_earnings import GetEarnings
-from kfinance.tool_calling.get_earnings_call_datetimes_from_identifier import (
-    GetEarningsCallDatetimesFromIdentifier,
-)
 from kfinance.tool_calling.get_financial_line_item_from_identifier import (
     GetFinancialLineItemFromIdentifier,
 )
@@ -39,7 +37,6 @@ ALL_TOOLS: list[Type[KfinanceTool]] = [
     GetIsinFromTicker,
     GetCusipFromTicker,
     GetInfoFromIdentifier,
-    GetEarningsCallDatetimesFromIdentifier,
     GetEarnings,
     GetLatestEarnings,
     GetNextEarnings,
@@ -52,4 +49,5 @@ ALL_TOOLS: list[Type[KfinanceTool]] = [
     GetBusinessRelationshipFromIdentifier,
     ResolveIdentifier,
     GetSegmentsFromIdentifier,
+    GetCompetitorsFromIdentifier,
 ]

kfinance/tool_calling/get_advisors_for_company_in_transaction_from_identifier.py

@@ -0,0 +1,39 @@
+from typing import Type
+
+from pydantic import BaseModel, Field
+
+from kfinance.constants import Permission
+from kfinance.kfinance import AdvisedCompany
+from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
+
+
+class GetAdvisorsForCompanyInTransactionFromIdentifierArgs(ToolArgsWithIdentifier):
+    transaction_id: int | None = Field(description="The ID of the merger.", default=None)
+
+
+class GetAdvisorsForCompanyInTransactionFromIdentifier(KfinanceTool):
+    name: str = "get_advisors_for_company_in_transaction_from_identifier"
+    description: str = 'Get the companies advising a company in a given transaction. For example, "Who advised S&P Global during their purchase of Kensho?"'
+    args_schema: Type[BaseModel] = GetAdvisorsForCompanyInTransactionFromIdentifierArgs
+    required_permission: Permission | None = Permission.MergersPermission
+
+    def _run(self, identifier: str, transaction_id: int) -> list:
+        ticker = self.kfinance_client.ticker(identifier)
+        advised_company = AdvisedCompany(
+            kfinance_api_client=ticker.kfinance_api_client,
+            company_id=ticker.company.company_id,
+            transaction_id=transaction_id,
+        )
+        advisors = advised_company.advisors
+
+        if advisors:
+            return [
+                {
+                    "advisor_company_id": advisor.company_id,
+                    "advisor_company_name": advisor.name,
+                    "advisor_type_name": advisor.advisor_type_name,
+                }
+                for advisor in advisors
+            ]
+        else:
+            return []

kfinance/tool_calling/get_competitors_from_identifier.py

@@ -0,0 +1,24 @@
+from kfinance.constants import CompetitorSource, Permission
+from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
+
+
+class GetCompetitorsFromIdentifierArgs(ToolArgsWithIdentifier):
+    # no description because the description for enum fields comes from the enum docstring.
+    competitor_source: CompetitorSource
+
+
+class GetCompetitorsFromIdentifier(KfinanceTool):
+    name: str = "get_competitors_from_identifier"
+    description: str = "Retrieves a list of competitors for a given company, optionally filtered by the source of the competitor information."
+    args_schema = GetCompetitorsFromIdentifierArgs
+    required_permission: Permission | None = Permission.CompetitorsPermission
+
+    def _run(
+        self,
+        identifier: str,
+        competitor_source: CompetitorSource,
+    ) -> dict:
+        ticker = self.kfinance_client.ticker(identifier)
+        return self.kfinance_client.kfinance_api_client.fetch_competitors(
+            company_id=ticker.company_id, competitor_source=competitor_source
+        )

kfinance/tool_calling/get_merger_info_from_transaction_id.py

@@ -0,0 +1,62 @@
+from typing import Type
+
+from pydantic import BaseModel, Field
+
+from kfinance.constants import Permission
+from kfinance.kfinance import MergerOrAcquisition
+from kfinance.tool_calling.shared_models import KfinanceTool
+
+
+class GetMergerInfoFromTransactionIdArgs(BaseModel):
+    transaction_id: int | None = Field(description="The ID of the merger.", default=None)
+
+
+class GetMergerInfoFromTransactionId(KfinanceTool):
+    name: str = "get_merger_info_from_transaction_id"
+    description: str = 'Get the timeline, the participants, and the consideration of the merger or acquisition from the given transaction ID. For example, "How much was Ben & Jerrys purchased for?" or "What was the price per share for LinkedIn?" or "When did S&P purchase Kensho?"'
+    args_schema: Type[BaseModel] = GetMergerInfoFromTransactionIdArgs
+    required_permission: Permission | None = Permission.MergersPermission
+
+    def _run(self, transaction_id: int) -> dict:
+        merger_or_acquisition = MergerOrAcquisition(
+            kfinance_api_client=self.kfinance_client.kfinance_api_client,
+            transaction_id=transaction_id,
+            merger_title=None,
+        )
+        merger_timeline = merger_or_acquisition.get_timeline
+        merger_participants = merger_or_acquisition.get_participants
+        merger_consideration = merger_or_acquisition.get_consideration
+
+        return {
+            "timeline": [
+                {"status": timeline["status"], "date": timeline["date"].strftime("%Y-%m-%d")}
+                for timeline in merger_timeline.to_dict(orient="records")
+            ],
+            "participants": {
+                "target": {
+                    "company_id": merger_participants["target"].company_id,
+                    "company_name": merger_participants["target"].name,
+                },
+                "buyers": [
+                    {"company_id": buyer.company_id, "company_name": buyer.name}
+                    for buyer in merger_participants["buyers"]
+                ],
+                "sellers": [
+                    {"company_id": seller.company_id, "company_name": seller.name}
+                    for seller in merger_participants["sellers"]
+                ],
+            },
+            "consideration": {
+                "currency_name": merger_consideration["currency_name"],
+                "current_calculated_gross_total_transaction_value": merger_consideration[
+                    "current_calculated_gross_total_transaction_value"
+                ],
+                "current_calculated_implied_equity_value": merger_consideration[
+                    "current_calculated_implied_equity_value"
+                ],
+                "current_calculated_implied_enterprise_value": merger_consideration[
+                    "current_calculated_implied_enterprise_value"
+                ],
+                "details": merger_consideration["details"].to_dict(orient="records"),
+            },
+        }

kfinance/tool_calling/get_mergers_from_identifier.py

@@ -0,0 +1,41 @@
+from typing import Type
+
+from pydantic import BaseModel
+
+from kfinance.constants import Permission
+from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
+
+
+class GetMergersFromIdentifier(KfinanceTool):
+    name: str = "get_mergers_from_identifier"
+    description: str = 'Get the transaction IDs that involve the given identifier. For example, "Which companies did Microsoft purchase?" or "Which company bought Ben & Jerrys?"'
+    args_schema: Type[BaseModel] = ToolArgsWithIdentifier
+    required_permission: Permission | None = Permission.MergersPermission
+
+    def _run(self, identifier: str) -> dict:
+        ticker = self.kfinance_client.ticker(identifier)
+        mergers_and_acquisitions = ticker.company.mergers_and_acquisitions
+
+        return {
+            "target": [
+                {
+                    "transaction_id": merger_or_acquisition.transaction_id,
+                    "merger_title": merger_or_acquisition.merger_title,
+                }
+                for merger_or_acquisition in mergers_and_acquisitions["target"]
+            ],
+            "buyer": [
+                {
+                    "transaction_id": merger_or_acquisition.transaction_id,
+                    "merger_title": merger_or_acquisition.merger_title,
+                }
+                for merger_or_acquisition in mergers_and_acquisitions["buyer"]
+            ],
+            "seller": [
+                {
+                    "transaction_id": merger_or_acquisition.transaction_id,
+                    "merger_title": merger_or_acquisition.merger_title,
+                }
+                for merger_or_acquisition in mergers_and_acquisitions["seller"]
+            ],
+        }

kfinance/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.4.3'
-__version_tuple__ = version_tuple = (2, 4, 3)
+__version__ = version = '2.6.1'
+__version_tuple__ = version_tuple = (2, 6, 1)

kfinance/tool_calling/get_earnings_call_datetimes_from_identifier.py

@@ -1,19 +0,0 @@
-import json
-from typing import Type
-
-from pydantic import BaseModel
-
-from kfinance.constants import Permission
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
-
-
-class GetEarningsCallDatetimesFromIdentifier(KfinanceTool):
-    name: str = "get_earnings_call_datetimes_from_identifier"
-    description: str = "Get earnings call datetimes associated with an identifier."
-    args_schema: Type[BaseModel] = ToolArgsWithIdentifier
-    required_permission: Permission | None = Permission.EarningsPermission
-
-    def _run(self, identifier: str) -> str:
-        ticker = self.kfinance_client.ticker(identifier)
-        earnings_call_datetimes = ticker.earnings_call_datetimes
-        return json.dumps([dt.isoformat() for dt in earnings_call_datetimes])