kensho-kfinance 2.9.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

kfinance/tool_calling/__init__.py

@@ -1,53 +0,0 @@
-from typing import Type
-
-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_financial_line_item_from_identifier import (
-    GetFinancialLineItemFromIdentifier,
-)
-from kfinance.tool_calling.get_financial_statement_from_identifier import (
-    GetFinancialStatementFromIdentifier,
-)
-from kfinance.tool_calling.get_history_metadata_from_identifier import (
-    GetHistoryMetadataFromIdentifier,
-)
-from kfinance.tool_calling.get_info_from_identifier import GetInfoFromIdentifier
-from kfinance.tool_calling.get_isin_from_ticker import GetIsinFromTicker
-from kfinance.tool_calling.get_latest import GetLatest
-from kfinance.tool_calling.get_latest_earnings import GetLatestEarnings
-from kfinance.tool_calling.get_n_quarters_ago import GetNQuartersAgo
-from kfinance.tool_calling.get_next_earnings import GetNextEarnings
-from kfinance.tool_calling.get_prices_from_identifier import GetPricesFromIdentifier
-from kfinance.tool_calling.get_segments_from_identifier import (
-    GetSegmentsFromIdentifier,
-)
-from kfinance.tool_calling.get_transcript import GetTranscript
-from kfinance.tool_calling.resolve_identifier import ResolveIdentifier
-from kfinance.tool_calling.shared_models import KfinanceTool
-
-
-ALL_TOOLS: list[Type[KfinanceTool]] = [
-    GetLatest,
-    GetNQuartersAgo,
-    GetIsinFromTicker,
-    GetCusipFromTicker,
-    GetInfoFromIdentifier,
-    GetEarnings,
-    GetLatestEarnings,
-    GetNextEarnings,
-    GetTranscript,
-    GetHistoryMetadataFromIdentifier,
-    GetPricesFromIdentifier,
-    GetCapitalizationFromIdentifier,
-    GetFinancialStatementFromIdentifier,
-    GetFinancialLineItemFromIdentifier,
-    GetBusinessRelationshipFromIdentifier,
-    ResolveIdentifier,
-    GetSegmentsFromIdentifier,
-    GetCompetitorsFromIdentifier,
-]

kfinance/tool_calling/get_advisors_for_company_in_transaction_from_identifier.py

@@ -1,42 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel, Field
-
-from kfinance.kfinance import Company, ParticipantInMerger
-from kfinance.models.permission_models import Permission
-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
-    accepted_permissions: set[Permission] | None = {Permission.MergersPermission}
-
-    def _run(self, identifier: str, transaction_id: int) -> list:
-        ticker = self.kfinance_client.ticker(identifier)
-        participant_in_merger = ParticipantInMerger(
-            kfinance_api_client=ticker.kfinance_api_client,
-            transaction_id=transaction_id,
-            company=Company(
-                kfinance_api_client=ticker.kfinance_api_client,
-                company_id=ticker.company.company_id,
-            ),
-        )
-        advisors = participant_in_merger.advisors
-
-        if advisors:
-            return [
-                {
-                    "advisor_company_id": advisor.company.company_id,
-                    "advisor_company_name": advisor.company.name,
-                    "advisor_type_name": advisor.advisor_type_name,
-                }
-                for advisor in advisors
-            ]
-        else:
-            return []

kfinance/tool_calling/get_business_relationship_from_identifier.py

@@ -1,30 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel
-
-from kfinance.kfinance import BusinessRelationships
-from kfinance.models.business_relationship_models import BusinessRelationshipType
-from kfinance.models.permission_models import Permission
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
-
-
-class GetBusinessRelationshipFromIdentifierArgs(ToolArgsWithIdentifier):
-    # no description because the description for enum fields comes from the enum docstring.
-    business_relationship: BusinessRelationshipType
-
-
-class GetBusinessRelationshipFromIdentifier(KfinanceTool):
-    name: str = "get_business_relationship_from_identifier"
-    description: str = 'Get the current and previous company IDs that are relationship_type of a given identifier. For example, "What are the current distributors of SPGI?" or "What are the previous borrowers of JPM?"'
-    args_schema: Type[BaseModel] = GetBusinessRelationshipFromIdentifierArgs
-    accepted_permissions: set[Permission] | None = {Permission.RelationshipPermission}
-
-    def _run(self, identifier: str, business_relationship: BusinessRelationshipType) -> dict:
-        ticker = self.kfinance_client.ticker(identifier)
-        business_relationship_obj: BusinessRelationships = getattr(
-            ticker, business_relationship.value
-        )
-        return {
-            "current": [company.company_id for company in business_relationship_obj.current],
-            "previous": [company.company_id for company in business_relationship_obj.previous],
-        }

kfinance/tool_calling/get_capitalization_from_identifier.py

@@ -1,35 +0,0 @@
-from datetime import date
-
-from pydantic import Field
-
-from kfinance.models.capitalization_models import Capitalization
-from kfinance.models.permission_models import Permission
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
-
-
-class GetCapitalizationFromIdentifierArgs(ToolArgsWithIdentifier):
-    # no description because the description for enum fields comes from the enum docstring.
-    capitalization: Capitalization
-    start_date: date | None = Field(
-        description="The start date for historical capitalization retrieval", default=None
-    )
-    end_date: date | None = Field(
-        description="The end date for historical capitalization retrieval", default=None
-    )
-
-
-class GetCapitalizationFromIdentifier(KfinanceTool):
-    name: str = "get_capitalization_from_identifier"
-    description: str = "Get the historical market cap, tev (Total Enterprise Value), or shares outstanding of an identifier between inclusive start_date and inclusive end date. When requesting the most recent values, leave start_date and end_date empty."
-    args_schema = GetCapitalizationFromIdentifierArgs
-    accepted_permissions: set[Permission] | None = {Permission.PricingPermission}
-
-    def _run(
-        self,
-        identifier: str,
-        capitalization: Capitalization,
-        start_date: str | None = None,
-        end_date: str | None = None,
-    ) -> dict:
-        ticker = self.kfinance_client.ticker(identifier)
-        return getattr(ticker, capitalization.value)(start_date=start_date, end_date=end_date)

kfinance/tool_calling/get_competitors_from_identifier.py

@@ -1,25 +0,0 @@
-from kfinance.models.competitor_models import CompetitorSource
-from kfinance.models.permission_models import 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 company_id and company_name that are competitors for a given company, optionally filtered by the source of the competitor information."
-    args_schema = GetCompetitorsFromIdentifierArgs
-    accepted_permissions: set[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_cusip_from_ticker.py

@@ -1,20 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel, Field
-
-from kfinance.models.permission_models import Permission
-from kfinance.tool_calling.shared_models import KfinanceTool
-
-
-class GetCusipFromTickerArgs(BaseModel):
-    ticker_str: str = Field(description="The ticker")
-
-
-class GetCusipFromTicker(KfinanceTool):
-    name: str = "get_cusip_from_ticker"
-    description: str = "Get the CUSIP associated with a ticker."
-    args_schema: Type[BaseModel] = GetCusipFromTickerArgs
-    accepted_permissions: set[Permission] | None = {Permission.IDPermission}
-
-    def _run(self, ticker_str: str) -> str:
-        return self.kfinance_client.ticker(ticker_str).cusip

kfinance/tool_calling/get_earnings.py

@@ -1,33 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel
-
-from kfinance.kfinance import NoEarningsDataError
-from kfinance.models.permission_models import Permission
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
-
-
-class GetEarnings(KfinanceTool):
-    name: str = "get_earnings"
-    description: str = "Get all earnings for a given identifier. Returns a list of dictionaries, each with 'name' (str), 'key_dev_id' (int), and 'datetime' (str in ISO 8601 format with UTC timezone) attributes."
-    args_schema: Type[BaseModel] = ToolArgsWithIdentifier
-    accepted_permissions: set[Permission] | None = {
-        Permission.EarningsPermission,
-        Permission.TranscriptsPermission,
-    }
-
-    def _run(self, identifier: str) -> list[dict]:
-        ticker = self.kfinance_client.ticker(identifier)
-        earnings = ticker.company.earnings()
-
-        if not earnings:
-            raise NoEarningsDataError(f"Earnings for {identifier} not found")
-
-        return [
-            {
-                "name": earnings_item.name,
-                "key_dev_id": earnings_item.key_dev_id,
-                "datetime": earnings_item.datetime.isoformat(),
-            }
-            for earnings_item in earnings
-        ]

kfinance/tool_calling/get_financial_line_item_from_identifier.py

@@ -1,48 +0,0 @@
-from typing import Literal, Type
-
-from pydantic import BaseModel, Field
-
-from kfinance.models.date_and_period_models import PeriodType
-from kfinance.models.line_item_models import LINE_ITEM_NAMES_AND_ALIASES
-from kfinance.models.permission_models import Permission
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier, ValidQuarter
-
-
-class GetFinancialLineItemFromIdentifierArgs(ToolArgsWithIdentifier):
-    # Note: mypy will not enforce this literal because of the type: ignore.
-    # But pydantic still uses the literal to check for allowed values and only includes
-    # allowed values in generated schemas.
-    line_item: Literal[tuple(LINE_ITEM_NAMES_AND_ALIASES)] = Field(  # type: ignore[valid-type]
-        description="The type of financial line_item requested"
-    )
-    period_type: PeriodType | None = Field(default=None, description="The period type")
-    start_year: int | None = Field(default=None, description="The starting year for the data range")
-    end_year: int | None = Field(default=None, description="The ending year for the data range")
-    start_quarter: ValidQuarter | None = Field(default=None, description="Starting quarter")
-    end_quarter: ValidQuarter | None = Field(default=None, description="Ending quarter")
-
-
-class GetFinancialLineItemFromIdentifier(KfinanceTool):
-    name: str = "get_financial_line_item_from_identifier"
-    description: str = "Get the financial line item associated with an identifier."
-    args_schema: Type[BaseModel] = GetFinancialLineItemFromIdentifierArgs
-    accepted_permissions: set[Permission] | None = {Permission.StatementsPermission}
-
-    def _run(
-        self,
-        identifier: str,
-        line_item: str,
-        period_type: PeriodType | None = None,
-        start_year: int | None = None,
-        end_year: int | None = None,
-        start_quarter: Literal[1, 2, 3, 4] | None = None,
-        end_quarter: Literal[1, 2, 3, 4] | None = None,
-    ) -> str:
-        ticker = self.kfinance_client.ticker(identifier)
-        return getattr(ticker, line_item)(
-            period_type=period_type,
-            start_year=start_year,
-            end_year=end_year,
-            start_quarter=start_quarter,
-            end_quarter=end_quarter,
-        ).to_markdown()

kfinance/tool_calling/get_financial_statement_from_identifier.py

@@ -1,44 +0,0 @@
-from typing import Literal, Type
-
-from pydantic import BaseModel, Field
-
-from kfinance.models.date_and_period_models import PeriodType
-from kfinance.models.permission_models import Permission
-from kfinance.models.statement_models import StatementType
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier, ValidQuarter
-
-
-class GetFinancialStatementFromIdentifierArgs(ToolArgsWithIdentifier):
-    # no description because the description for enum fields comes from the enum docstring.
-    statement: StatementType
-    period_type: PeriodType | None = Field(default=None, description="The period type")
-    start_year: int | None = Field(default=None, description="The starting year for the data range")
-    end_year: int | None = Field(default=None, description="The ending year for the data range")
-    start_quarter: ValidQuarter | None = Field(default=None, description="Starting quarter")
-    end_quarter: ValidQuarter | None = Field(default=None, description="Ending quarter")
-
-
-class GetFinancialStatementFromIdentifier(KfinanceTool):
-    name: str = "get_financial_statement_from_identifier"
-    description: str = "Get the financial statement associated with an identifier."
-    args_schema: Type[BaseModel] = GetFinancialStatementFromIdentifierArgs
-    accepted_permissions: set[Permission] | None = {Permission.StatementsPermission}
-
-    def _run(
-        self,
-        identifier: str,
-        statement: StatementType,
-        period_type: PeriodType | None = None,
-        start_year: int | None = None,
-        end_year: int | None = None,
-        start_quarter: Literal[1, 2, 3, 4] | None = None,
-        end_quarter: Literal[1, 2, 3, 4] | None = None,
-    ) -> str:
-        ticker = self.kfinance_client.ticker(identifier)
-        return getattr(ticker, statement.value)(
-            period_type=period_type,
-            start_year=start_year,
-            end_year=end_year,
-            start_quarter=start_quarter,
-            end_quarter=end_quarter,
-        ).to_markdown()

kfinance/tool_calling/get_history_metadata_from_identifier.py

@@ -1,17 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel
-
-from kfinance.models.permission_models import Permission
-from kfinance.models.price_models import HistoryMetadata
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
-
-
-class GetHistoryMetadataFromIdentifier(KfinanceTool):
-    name: str = "get_history_metadata_from_identifier"
-    description: str = "Get the history metadata associated with an identifier. History metadata includes currency, symbol, exchange name, instrument type, and first trade date."
-    args_schema: Type[BaseModel] = ToolArgsWithIdentifier
-    accepted_permissions: set[Permission] | None = None
-
-    def _run(self, identifier: str) -> HistoryMetadata:
-        return self.kfinance_client.ticker(identifier).history_metadata

kfinance/tool_calling/get_info_from_identifier.py

@@ -1,16 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel
-
-from kfinance.models.permission_models import Permission
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
-
-
-class GetInfoFromIdentifier(KfinanceTool):
-    name: str = "get_info_from_identifier"
-    description: str = "Get the information associated with an identifier. Info includes company name, status, type, simple industry, number of employees (if available), founding date, webpage, HQ address, HQ city, HQ zip code, HQ state, HQ country, and HQ country iso code."
-    args_schema: Type[BaseModel] = ToolArgsWithIdentifier
-    accepted_permissions: set[Permission] | None = None
-
-    def _run(self, identifier: str) -> str:
-        return str(self.kfinance_client.ticker(identifier).info)

kfinance/tool_calling/get_isin_from_ticker.py

@@ -1,20 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel, Field
-
-from kfinance.models.permission_models import Permission
-from kfinance.tool_calling.shared_models import KfinanceTool
-
-
-class GetIsinFromTickerArgs(BaseModel):
-    ticker_str: str = Field(description="The ticker")
-
-
-class GetIsinFromTicker(KfinanceTool):
-    name: str = "get_isin_from_ticker"
-    description: str = "Get the ISIN associated with a ticker."
-    args_schema: Type[BaseModel] = GetIsinFromTickerArgs
-    accepted_permissions: set[Permission] | None = {Permission.IDPermission}
-
-    def _run(self, ticker_str: str) -> str:
-        return self.kfinance_client.ticker(ticker_str).isin

kfinance/tool_calling/get_latest_earnings.py

@@ -1,30 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel
-
-from kfinance.kfinance import NoEarningsDataError
-from kfinance.models.permission_models import Permission
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
-
-
-class GetLatestEarnings(KfinanceTool):
-    name: str = "get_latest_earnings"
-    description: str = "Get the latest earnings for a given identifier. Returns a dictionary with 'name' (str), 'key_dev_id' (int), and 'datetime' (str in ISO 8601 format with UTC timezone) attributes."
-    args_schema: Type[BaseModel] = ToolArgsWithIdentifier
-    accepted_permissions: set[Permission] | None = {
-        Permission.EarningsPermission,
-        Permission.TranscriptsPermission,
-    }
-
-    def _run(self, identifier: str) -> dict:
-        ticker = self.kfinance_client.ticker(identifier)
-        latest_earnings = ticker.company.latest_earnings
-
-        if latest_earnings is None:
-            raise NoEarningsDataError(f"Latest earnings for {identifier} not found")
-
-        return {
-            "name": latest_earnings.name,
-            "key_dev_id": latest_earnings.key_dev_id,
-            "datetime": latest_earnings.datetime.isoformat(),
-        }

kfinance/tool_calling/get_merger_info_from_transaction_id.py

@@ -1,69 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel, Field
-
-from kfinance.kfinance import MergerOrAcquisition
-from kfinance.models.permission_models import Permission
-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
-    accepted_permissions: set[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,
-            closed_date=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")
-            ]
-            if merger_timeline is not None
-            else None,
-            "participants": {
-                "target": {
-                    "company_id": merger_participants["target"].company.company_id,
-                    "company_name": merger_participants["target"].company.name,
-                },
-                "buyers": [
-                    {"company_id": buyer.company.company_id, "company_name": buyer.company.name}
-                    for buyer in merger_participants["buyers"]
-                ],
-                "sellers": [
-                    {"company_id": seller.company.company_id, "company_name": seller.company.name}
-                    for seller in merger_participants["sellers"]
-                ],
-            }
-            if merger_participants is not None
-            else None,
-            "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"),
-            }
-            if merger_consideration is not None
-            else None,
-        }

kfinance/tool_calling/get_mergers_from_identifier.py

@@ -1,44 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel
-
-from kfinance.models.permission_models 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
-    accepted_permissions: set[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,
-                    "closed_date": merger_or_acquisition.closed_date,
-                }
-                for merger_or_acquisition in mergers_and_acquisitions["target"]
-            ],
-            "buyer": [
-                {
-                    "transaction_id": merger_or_acquisition.transaction_id,
-                    "merger_title": merger_or_acquisition.merger_title,
-                    "closed_date": merger_or_acquisition.closed_date,
-                }
-                for merger_or_acquisition in mergers_and_acquisitions["buyer"]
-            ],
-            "seller": [
-                {
-                    "transaction_id": merger_or_acquisition.transaction_id,
-                    "merger_title": merger_or_acquisition.merger_title,
-                    "closed_date": merger_or_acquisition.closed_date,
-                }
-                for merger_or_acquisition in mergers_and_acquisitions["seller"]
-            ],
-        }

kfinance/tool_calling/get_next_earnings.py

@@ -1,30 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel
-
-from kfinance.kfinance import NoEarningsDataError
-from kfinance.models.permission_models import Permission
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
-
-
-class GetNextEarnings(KfinanceTool):
-    name: str = "get_next_earnings"
-    description: str = "Get the next earnings for a given identifier. Returns a dictionary with 'name' (str), 'key_dev_id' (int), and 'datetime' (str in ISO 8601 format with UTC timezone) attributes."
-    args_schema: Type[BaseModel] = ToolArgsWithIdentifier
-    accepted_permissions: set[Permission] | None = {
-        Permission.EarningsPermission,
-        Permission.TranscriptsPermission,
-    }
-
-    def _run(self, identifier: str) -> dict:
-        ticker = self.kfinance_client.ticker(identifier)
-        next_earnings = ticker.company.next_earnings
-
-        if next_earnings is None:
-            raise NoEarningsDataError(f"Next earnings for {identifier} not found")
-
-        return {
-            "name": next_earnings.name,
-            "key_dev_id": next_earnings.key_dev_id,
-            "datetime": next_earnings.datetime.isoformat(),
-        }

kfinance/tool_calling/get_prices_from_identifier.py

@@ -1,46 +0,0 @@
-from datetime import date
-from typing import Type
-
-from pydantic import BaseModel, Field
-
-from kfinance.models.date_and_period_models import Periodicity
-from kfinance.models.permission_models import Permission
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
-
-
-class GetPricesFromIdentifierArgs(ToolArgsWithIdentifier):
-    start_date: date | None = Field(
-        description="The start date for historical price retrieval", default=None
-    )
-    end_date: date | None = Field(
-        description="The end date for historical price retrieval", default=None
-    )
-    # no description because the description for enum fields comes from the enum docstring.
-    periodicity: Periodicity = Field(default=Periodicity.day)
-    adjusted: bool = Field(
-        description="Whether to retrieve adjusted prices that account for corporate actions such as dividends and splits.",
-        default=True,
-    )
-
-
-class GetPricesFromIdentifier(KfinanceTool):
-    name: str = "get_prices_from_identifier"
-    description: str = "Get the historical open, high, low, and close prices, and volume of an identifier between inclusive start_date and inclusive end date. When requesting the most recent values, leave start_date and end_date empty."
-    args_schema: Type[BaseModel] = GetPricesFromIdentifierArgs
-    accepted_permissions: set[Permission] | None = {Permission.PricingPermission}
-
-    def _run(
-        self,
-        identifier: str,
-        start_date: date | None = None,
-        end_date: date | None = None,
-        periodicity: Periodicity = Periodicity.day,
-        adjusted: bool = True,
-    ) -> dict:
-        ticker = self.kfinance_client.ticker(identifier)
-        return ticker.history(
-            start_date=start_date.isoformat() if start_date else None,
-            end_date=end_date.isoformat() if end_date else None,
-            periodicity=periodicity,
-            adjusted=adjusted,
-        ).model_dump(mode="json")

kfinance/tool_calling/get_segments_from_identifier.py

@@ -1,44 +0,0 @@
-from typing import Literal, Type
-
-from pydantic import BaseModel, Field
-
-from kfinance.models.date_and_period_models import PeriodType
-from kfinance.models.permission_models import Permission
-from kfinance.models.segment_models import SegmentType
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier, ValidQuarter
-
-
-class GetSegmentsFromIdentifierArgs(ToolArgsWithIdentifier):
-    # no description because the description for enum fields comes from the enum docstring.
-    segment_type: SegmentType
-    period_type: PeriodType | None = Field(default=None, description="The period type")
-    start_year: int | None = Field(default=None, description="The starting year for the data range")
-    end_year: int | None = Field(default=None, description="The ending year for the data range")
-    start_quarter: ValidQuarter | None = Field(default=None, description="Starting quarter")
-    end_quarter: ValidQuarter | None = Field(default=None, description="Ending quarter")
-
-
-class GetSegmentsFromIdentifier(KfinanceTool):
-    name: str = "get_segments_from_identifier"
-    description: str = "Get the templated segments associated with an identifier."
-    args_schema: Type[BaseModel] = GetSegmentsFromIdentifierArgs
-    accepted_permissions: set[Permission] | None = {Permission.SegmentsPermission}
-
-    def _run(
-        self,
-        identifier: str,
-        segment_type: SegmentType,
-        period_type: PeriodType | None = None,
-        start_year: int | None = None,
-        end_year: int | None = None,
-        start_quarter: Literal[1, 2, 3, 4] | None = None,
-        end_quarter: Literal[1, 2, 3, 4] | None = None,
-    ) -> str:
-        ticker = self.kfinance_client.ticker(identifier)
-        return getattr(ticker, segment_type.value + "_segments")(
-            period_type=period_type,
-            start_year=start_year,
-            end_year=end_year,
-            start_quarter=start_quarter,
-            end_quarter=end_quarter,
-        )