kensho-kfinance 2.6.3__tar.gz → 2.6.5__tar.gz

{kensho_kfinance-2.6.3/kensho_kfinance.egg-info → kensho_kfinance-2.6.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.6.3
+Version: 2.6.5
 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.6.3 → kensho_kfinance-2.6.5/kensho_kfinance.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.6.3
+Version: 2.6.5
 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.6.3 → kensho_kfinance-2.6.5}/kfinance/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-# v2.6.3
+## v2.6.5
+ - Add competitor company_name
+
+## v2.6.4
+- Add transcript permission and update accepted_permissions type to set[Permission]
+
+## v2.6.3
 - Bump urllib3 to 2.5 to  address CVEs
 
 ## v2.6.2

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/constants.py

@@ -94,6 +94,7 @@ class BusinessRelationshipType(StrEnum):
 
 class Permission(StrEnum):
     EarningsPermission = "EarningsPermission"
+    TranscriptsPermission = "TranscriptsPermission"
     GICSPermission = "GICSPermission"
     IDPermission = "IDPermission"
     ISCRSPermission = "ISCRSPermission"

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/kfinance.py

@@ -1644,8 +1644,11 @@ class Client:
             for tool_cls in ALL_TOOLS:
                 tool = tool_cls(kfinance_client=self)  # type: ignore[call-arg]
                 if (
-                    tool.required_permission is None
-                    or tool.required_permission in self.kfinance_api_client.user_permissions
+                    tool.accepted_permissions is None
+                    # if one or more of the required permission for a tool is a permission the user has
+                    or tool.accepted_permissions.intersection(
+                        self.kfinance_api_client.user_permissions
+                    )
                 ):
                     self._tools.append(tool)
 

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/meta_classes.py

@@ -427,19 +427,26 @@ class CompanyFunctionsMetaClass:
     def competitors(
         self, competitor_source: CompetitorSource = CompetitorSource.all
     ) -> "Companies":
-        """Get the list of companies that are competitors of company_id, optionally filtered by the competitor_source type.
+        """Get the list of company_id and company_name that are competitors of company_id, optionally filtered by the competitor_source type.
 
-        :return: The list of companies that are competitors of company_id, optionally filtered by the competitor_source type
+        :return: The list of company_id and company_name that are competitors of company_id, optionally filtered by the competitor_source type
         :rtype: Companies
         """
-        from .kfinance import Companies
+        from .kfinance import Companies, Company
 
         competitors_data = self.kfinance_api_client.fetch_competitors(
             company_id=self.company_id, competitor_source=competitor_source
-        )["companies"]
+        )["competitors"]
         return Companies(
             kfinance_api_client=self.kfinance_api_client,
-            company_ids=[company["company_id"] for company in competitors_data],
+            companies=[
+                Company(
+                    kfinance_api_client=self.kfinance_api_client,
+                    company_id=company["company_id"],
+                    company_name=company["company_name"],
+                )
+                for company in competitors_data
+            ],
         )
 
 

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tests/test_client.py

@@ -6,9 +6,14 @@ from kfinance.constants import Permission
 from kfinance.kfinance import Client
 from kfinance.tool_calling import (
     GetBusinessRelationshipFromIdentifier,
+    GetEarnings,
     GetFinancialStatementFromIdentifier,
     GetLatest,
+    GetLatestEarnings,
+    GetNextEarnings,
+    GetTranscript,
 )
+from kfinance.tool_calling.shared_models import KfinanceTool
 
 
 class TestLangchainTools:
@@ -52,3 +57,33 @@ class TestLangchainTools:
         assert GetLatest in tool_classes
         # User should not have access to functions that require statement permissions
         assert GetFinancialStatementFromIdentifier not in tool_classes
+
+    @pytest.mark.parametrize(
+        "user_permission, expected_tool",
+        [
+            pytest.param(
+                Permission.TranscriptsPermission, GetTranscript, id="Transcript Permissions"
+            ),
+            pytest.param(Permission.EarningsPermission, GetEarnings, id="Earnings Permissions"),
+        ],
+    )
+    def test_permission_set_handling(
+        self, user_permission: Permission, expected_tool: KfinanceTool, mock_client: Client
+    ):
+        """
+        GIVEN a user with a permission that is in a set of required permission for a tool
+        WHEN we filter tools by permissions
+        THEN we successfully return the correct tools that either don't require permissions or tools that the user
+            specifically has access to.
+        """
+        mock_client.kfinance_api_client._user_permissions = {user_permission}  # noqa: SLF001
+        tool_classes = [type(t) for t in mock_client.langchain_tools]
+        # User should have access to GetEarnings, GetNextEarnings, GetLatestEarnings, GetTranscript
+        assert GetEarnings in tool_classes
+        assert GetNextEarnings in tool_classes
+        assert GetLatestEarnings in tool_classes
+        assert expected_tool in tool_classes
+        # User should have access to functions that don't require permissions
+        assert GetLatest in tool_classes
+        # User should not have access to functions that require statement permissions
+        assert GetFinancialStatementFromIdentifier not in tool_classes

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_advisors_for_company_in_transaction_from_identifier.py

@@ -15,7 +15,7 @@ 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
+    accepted_permissions: set[Permission] | None = {Permission.MergersPermission}
 
     def _run(self, identifier: str, transaction_id: int) -> list:
         ticker = self.kfinance_client.ticker(identifier)

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_business_relationship_from_identifier.py

@@ -16,7 +16,7 @@ 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
-    required_permission: Permission | None = Permission.RelationshipPermission
+    accepted_permissions: set[Permission] | None = {Permission.RelationshipPermission}
 
     def _run(self, identifier: str, business_relationship: BusinessRelationshipType) -> dict:
         ticker = self.kfinance_client.ticker(identifier)

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_capitalization_from_identifier.py

@@ -21,7 +21,7 @@ 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
-    required_permission: Permission | None = Permission.PricingPermission
+    accepted_permissions: set[Permission] | None = {Permission.PricingPermission}
 
     def _run(
         self,

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_competitors_from_identifier.py

@@ -9,9 +9,9 @@ class GetCompetitorsFromIdentifierArgs(ToolArgsWithIdentifier):
 
 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."
+    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
-    required_permission: Permission | None = Permission.CompetitorsPermission
+    accepted_permissions: set[Permission] | None = {Permission.CompetitorsPermission}
 
     def _run(
         self,

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_cusip_from_ticker.py

@@ -14,7 +14,7 @@ class GetCusipFromTicker(KfinanceTool):
     name: str = "get_cusip_from_ticker"
     description: str = "Get the CUSIP associated with a ticker."
     args_schema: Type[BaseModel] = GetCusipFromTickerArgs
-    required_permission: Permission | None = Permission.IDPermission
+    accepted_permissions: set[Permission] | None = {Permission.IDPermission}
 
     def _run(self, ticker_str: str) -> str:
         return self.kfinance_client.ticker(ticker_str).cusip

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_earnings.py

@@ -11,7 +11,10 @@ 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
-    required_permission: Permission | None = Permission.EarningsPermission
+    accepted_permissions: set[Permission] | None = {
+        Permission.EarningsPermission,
+        Permission.TranscriptsPermission,
+    }
 
     def _run(self, identifier: str) -> list[dict]:
         ticker = self.kfinance_client.ticker(identifier)

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_financial_line_item_from_identifier.py

@@ -24,7 +24,7 @@ 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
-    required_permission: Permission | None = Permission.StatementsPermission
+    accepted_permissions: set[Permission] | None = {Permission.StatementsPermission}
 
     def _run(
         self,

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_financial_statement_from_identifier.py

@@ -20,7 +20,7 @@ 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
-    required_permission: Permission | None = Permission.StatementsPermission
+    accepted_permissions: set[Permission] | None = {Permission.StatementsPermission}
 
     def _run(
         self,

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_history_metadata_from_identifier.py

@@ -10,7 +10,7 @@ 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
-    required_permission: Permission | None = None
+    accepted_permissions: set[Permission] | None = None
 
     def _run(self, identifier: str) -> HistoryMetadata:
         return self.kfinance_client.ticker(identifier).history_metadata

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_info_from_identifier.py

@@ -10,7 +10,7 @@ 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
-    required_permission: Permission | None = None
+    accepted_permissions: set[Permission] | None = None
 
     def _run(self, identifier: str) -> str:
         return str(self.kfinance_client.ticker(identifier).info)

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_isin_from_ticker.py

@@ -14,7 +14,7 @@ class GetIsinFromTicker(KfinanceTool):
     name: str = "get_isin_from_ticker"
     description: str = "Get the ISIN associated with a ticker."
     args_schema: Type[BaseModel] = GetIsinFromTickerArgs
-    required_permission: Permission | None = Permission.IDPermission
+    accepted_permissions: set[Permission] | None = {Permission.IDPermission}
 
     def _run(self, ticker_str: str) -> str:
         return self.kfinance_client.ticker(ticker_str).isin

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_latest.py

@@ -16,7 +16,7 @@ class GetLatest(KfinanceTool):
     name: str = "get_latest"
     description: str = "Get the latest annual reporting year, latest quarterly reporting quarter and year, and current date."
     args_schema: Type[BaseModel] = GetLatestArgs
-    required_permission: Permission | None = None
+    accepted_permissions: set[Permission] | None = None
 
     def _run(self, use_local_timezone: bool = True) -> LatestPeriods:
         return self.kfinance_client.get_latest(use_local_timezone=use_local_timezone)

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_latest_earnings.py

@@ -11,7 +11,10 @@ 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
-    required_permission: Permission | None = Permission.EarningsPermission
+    accepted_permissions: set[Permission] | None = {
+        Permission.EarningsPermission,
+        Permission.TranscriptsPermission,
+    }
 
     def _run(self, identifier: str) -> dict:
         ticker = self.kfinance_client.ticker(identifier)

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_merger_info_from_transaction_id.py

@@ -15,7 +15,7 @@ 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
+    accepted_permissions: set[Permission] | None = {Permission.MergersPermission}
 
     def _run(self, transaction_id: int) -> dict:
         merger_or_acquisition = MergerOrAcquisition(

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_mergers_from_identifier.py

@@ -10,7 +10,7 @@ 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
+    accepted_permissions: set[Permission] | None = {Permission.MergersPermission}
 
     def _run(self, identifier: str) -> dict:
         ticker = self.kfinance_client.ticker(identifier)

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_n_quarters_ago.py

@@ -16,7 +16,7 @@ class GetNQuartersAgo(KfinanceTool):
         "Get the year and quarter corresponding to [n] quarters before the current quarter."
     )
     args_schema: Type[BaseModel] = GetNQuartersAgoArgs
-    required_permission: Permission | None = None
+    accepted_permissions: set[Permission] | None = None
 
     def _run(self, n: int) -> YearAndQuarter:
         return self.kfinance_client.get_n_quarters_ago(n)

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_next_earnings.py

@@ -11,7 +11,10 @@ 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
-    required_permission: Permission | None = Permission.EarningsPermission
+    accepted_permissions: set[Permission] | None = {
+        Permission.EarningsPermission,
+        Permission.TranscriptsPermission,
+    }
 
     def _run(self, identifier: str) -> dict:
         ticker = self.kfinance_client.ticker(identifier)

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_prices_from_identifier.py

@@ -26,7 +26,7 @@ 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
-    required_permission: Permission | None = Permission.PricingPermission
+    accepted_permissions: set[Permission] | None = {Permission.PricingPermission}
 
     def _run(
         self,

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_segments_from_identifier.py

@@ -20,7 +20,7 @@ class GetSegmentsFromIdentifier(KfinanceTool):
     name: str = "get_segments_from_identifier"
     description: str = "Get the templated segments associated with an identifier."
     args_schema: Type[BaseModel] = GetSegmentsFromIdentifierArgs
-    required_permission: Permission | None = Permission.SegmentsPermission
+    accepted_permissions: set[Permission] | None = {Permission.SegmentsPermission}
 
     def _run(
         self,

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/get_transcript.py

@@ -16,7 +16,7 @@ class GetTranscript(KfinanceTool):
     name: str = "get_transcript"
     description: str = "Get the raw transcript text for an earnings call by key dev ID."
     args_schema: Type[BaseModel] = GetTranscriptArgs
-    required_permission: Permission | None = Permission.EarningsPermission
+    accepted_permissions: set[Permission] | None = {Permission.TranscriptsPermission}
 
     def _run(self, key_dev_id: int) -> str:
         transcript = self.kfinance_client.transcript(key_dev_id)

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/resolve_identifier.py

@@ -12,7 +12,7 @@ class ResolveIdentifier(KfinanceTool):
         "Get the company_id, security_id, and trading_item_id associated with an identifier."
     )
     args_schema: Type[BaseModel] = ToolArgsWithIdentifier
-    required_permission: Permission | None = None
+    accepted_permissions: set[Permission] | None = None
 
     def _run(self, identifier: str) -> dict[str, int]:
         return self.kfinance_client.ticker(identifier).id_triple._asdict()

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/tool_calling/shared_models.py

@@ -16,7 +16,9 @@ class KfinanceTool(BaseTool):
 
     kfinance_client: Client
     args_schema: Type[BaseModel]
-    required_permission: Permission | None
+    accepted_permissions: set[Permission] | None = Field(
+        description="The set of accepted permissions needed to access the tool. Only one of the permissions is required (or None)."
+    )
 
     model_config = ConfigDict(populate_by_name=True, extra="forbid")
 

{kensho_kfinance-2.6.3 → kensho_kfinance-2.6.5}/kfinance/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.6.3'
-__version_tuple__ = version_tuple = (2, 6, 3)
+__version__ = version = '2.6.5'
+__version_tuple__ = version_tuple = (2, 6, 5)