kensho-kfinance 2.0.1__py3-none-any.whl → 2.2.2__py3-none-any.whl

kfinance/tool_calling/get_info_from_identifier.py

@@ -2,13 +2,15 @@ from typing import Type
 
 from pydantic import BaseModel
 
+from kfinance.constants 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, founding date, webpage, HQ address, HQ city, HQ zip code, HQ state, HQ country, and HQ country iso code."
+    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
 
     def _run(self, identifier: str) -> str:
         return str(self.kfinance_client.ticker(identifier).info)

kfinance/tool_calling/get_isin_from_ticker.py

@@ -2,6 +2,7 @@ from typing import Type
 
 from pydantic import BaseModel, Field
 
+from kfinance.constants import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool
 
 
@@ -13,6 +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
 
     def _run(self, ticker_str: str) -> str:
         return self.kfinance_client.ticker(ticker_str).isin

kfinance/tool_calling/get_latest.py

@@ -2,7 +2,7 @@ from typing import Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import LatestPeriods
+from kfinance.constants import LatestPeriods, Permission
 from kfinance.tool_calling.shared_models import KfinanceTool
 
 
@@ -16,6 +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
 
     def _run(self, use_local_timezone: bool = True) -> LatestPeriods:
         return self.kfinance_client.get_latest(use_local_timezone=use_local_timezone)

kfinance/tool_calling/get_n_quarters_ago.py

@@ -2,7 +2,7 @@ from typing import Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import YearAndQuarter
+from kfinance.constants import Permission, YearAndQuarter
 from kfinance.tool_calling.shared_models import KfinanceTool
 
 
@@ -16,6 +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
 
     def _run(self, n: int) -> YearAndQuarter:
         return self.kfinance_client.get_n_quarters_ago(n)

kfinance/tool_calling/get_prices_from_identifier.py

@@ -3,7 +3,7 @@ from typing import Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import Periodicity
+from kfinance.constants import Periodicity, Permission
 from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
 
 
@@ -26,6 +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
 
     def _run(
         self,

kfinance/tool_calling/resolve_identifier.py

@@ -0,0 +1,18 @@
+from typing import Type
+
+from pydantic import BaseModel
+
+from kfinance.constants import Permission
+from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
+
+
+class ResolveIdentifier(KfinanceTool):
+    name: str = "resolve_identifier"
+    description: str = (
+        "Get the company_id, security_id, and trading_item_id associated with an identifier."
+    )
+    args_schema: Type[BaseModel] = ToolArgsWithIdentifier
+    required_permission: Permission | None = None
+
+    def _run(self, identifier: str) -> dict[str, int]:
+        return self.kfinance_client.ticker(identifier).id_triple._asdict()

kfinance/tool_calling/shared_models.py

@@ -3,6 +3,7 @@ from typing import Any, Type
 from langchain_core.tools import BaseTool
 from pydantic import BaseModel, ConfigDict, Field
 
+from kfinance.constants import Permission
 from kfinance.kfinance import Client
 
 
@@ -15,6 +16,7 @@ class KfinanceTool(BaseTool):
 
     kfinance_client: Client
     args_schema: Type[BaseModel]
+    required_permission: Permission | None
 
     model_config = ConfigDict(populate_by_name=True, extra="forbid")
 

kfinance/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.0.1'
-__version_tuple__ = version_tuple = (2, 0, 1)
+__version__ = version = '2.2.2'
+__version_tuple__ = version_tuple = (2, 2, 2)

kensho_kfinance-2.0.1.dist-info/RECORD

@@ -1,40 +0,0 @@
-kensho_kfinance-2.0.1.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
-kensho_kfinance-2.0.1.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
-kfinance/CHANGELOG.md,sha256=I8bZTKar4ZBpKlexO86HTUV4jPKKlKzsCHpDv-UZB4Q,697
-kfinance/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/batch_request_handling.py,sha256=s0uXRY4CC-GnShI0i8PLPgLddRdqLyQ8jnqDKdmaZzs,5531
-kfinance/constants.py,sha256=HrTh2QuhbA70xxcJ6N8WfTOJs6YiM30P59GbSDu_3AY,48312
-kfinance/fetch.py,sha256=ygvp8q1o8mqPYY4ctQwch37dmprO0UMDteDumk8A-Gw,20172
-kfinance/kfinance.py,sha256=nw2SPkixFht3PkcH4tZ1FnLhVxmyZm1_gbOqnmC6PBQ,49219
-kfinance/meta_classes.py,sha256=sNezG7uHAQOWj2Xdjao6qc3z_gHppgJat7O9J2k_yqI,15730
-kfinance/prompt.py,sha256=PtVB8c_FcSlVdyGgByAnIFGzuUuBaEjciCqnBJl1hSQ,25133
-kfinance/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/server_thread.py,sha256=jUnt1YGoYDkqqz1MbCwd44zJs1T_Z2BCgvj75bdtLgA,2574
-kfinance/version.py,sha256=0PAtIHDEagdGmwgz1nnz5zUKeyYjsxtV8Nbsv7dXl8w,511
-kfinance/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/tests/test_batch_requests.py,sha256=NsldoZqjjQpv0QKM2th80F1nru2tIF4LJeXU-RamQvA,9836
-kfinance/tests/test_fetch.py,sha256=iJLOPBOb8xdAGF6Jel5jPhWb4iW6yPpt9f5tW4uZEyo,12189
-kfinance/tests/test_objects.py,sha256=egXkhfoK2MepZdXtrBxzWxWni7f-zVCefUbnyDnWDOE,22554
-kfinance/tests/test_tools.py,sha256=YG5UVWnR4EyHGsL4bBwUp2auSd55lcvUEEncXcMXw1Q,16941
-kfinance/tool_calling/README.md,sha256=omJq7Us6r4U45QB7hRpLjRJ5BMalCkZkh4uXBjTbJXc,2022
-kfinance/tool_calling/__init__.py,sha256=GDEeK2zM2tOfYam6ejwYACXecoRdlkRve_ZC5VTKugo,2038
-kfinance/tool_calling/get_business_relationship_from_identifier.py,sha256=S_-nCsppi9tvwC81GMKvJd-eZSwRejT96PZhlOf5Wv4,1381
-kfinance/tool_calling/get_capitalization_from_identifier.py,sha256=LmH5yEWSRJfAP4kRYHREdbMtrmxcZfgfbNB4dGQwyb4,1435
-kfinance/tool_calling/get_company_id_from_identifier.py,sha256=18XAmWxTXRw1qaqw4WuA-yQ4d7kI2HnbMi32d-xNGzE,485
-kfinance/tool_calling/get_cusip_from_ticker.py,sha256=uzVMbtcV4eKtWO4bYn-cicCo8tfAEGk-v95ZOON_cbA,533
-kfinance/tool_calling/get_earnings_call_datetimes_from_identifier.py,sha256=3v73ZZz9n-Rdp5vp1RPmFD41nJ0Z3EgTjFSbnm30xdA,665
-kfinance/tool_calling/get_financial_line_item_from_identifier.py,sha256=zJ-kcr_B9N3ZIXK1W-2TEUlF6tj4rhzmLSsW8EUhJn4,2064
-kfinance/tool_calling/get_financial_statement_from_identifier.py,sha256=LyGmh81-_yljOhMVpsXa1M4u6hNJNP69Ms1M1NsxwPM,1817
-kfinance/tool_calling/get_history_metadata_from_identifier.py,sha256=0h7xdhrIJg3pJJrrCgcsiZd3ft1GpConhNZe2pcOREA,666
-kfinance/tool_calling/get_info_from_identifier.py,sha256=bv4lRhXWG9N7U8XEli9v44QEXNgf7-ZTuTDmE6XIeEg,659
-kfinance/tool_calling/get_isin_from_ticker.py,sha256=yz7SOCFgwL03Zd8zG3pIfa3McB_tdRU-_oXYfSfqWoo,527
-kfinance/tool_calling/get_latest.py,sha256=U_5SuGlD0G-u7YreiNkwEtx2zkUhZzUvwUwdL_tmqFk,724
-kfinance/tool_calling/get_n_quarters_ago.py,sha256=VVKKyUNbmw7fS7e-vi4YXSdd_OO2bo8k50Grt5F_Mvo,651
-kfinance/tool_calling/get_prices_from_identifier.py,sha256=b-cK9dWXbVBjppTORlC4HK9zd_qe8V0n98s823v0dCc,1796
-kfinance/tool_calling/get_security_id_from_identifier.py,sha256=vPFYuFydUGxQ0b23CWkU3YxWVeoW-nzsrPbB9ZH8U_w,489
-kfinance/tool_calling/get_trading_item_id_from_identifier.py,sha256=fB8QBFzhn-kgUL8dSF6w_rtO3zG5yLbm5s29Xz6U1AY,504
-kfinance/tool_calling/shared_models.py,sha256=6y74yJCORHDVBxhhBJhTUOWCF9D11Lgg9eYQeDIT3aY,2047
-kensho_kfinance-2.0.1.dist-info/METADATA,sha256=ZbBhphkOAf3Bk9yqaO42W5rPJYOW1jcO0HvjVGaYnSo,3051
-kensho_kfinance-2.0.1.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
-kensho_kfinance-2.0.1.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
-kensho_kfinance-2.0.1.dist-info/RECORD,,

kfinance/tool_calling/get_company_id_from_identifier.py

@@ -1,14 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel
-
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
-
-
-class GetCompanyIdFromIdentifier(KfinanceTool):
-    name: str = "get_company_id_from_identifier"
-    description: str = "Get the company id associated with an identifier."
-    args_schema: Type[BaseModel] = ToolArgsWithIdentifier
-
-    def _run(self, identifier: str) -> int:
-        return self.kfinance_client.ticker(identifier).company_id

kfinance/tool_calling/get_security_id_from_identifier.py

@@ -1,14 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel
-
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
-
-
-class GetSecurityIdFromIdentifier(KfinanceTool):
-    name: str = "get_security_id_from_identifier"
-    description: str = "Get the security id associated with an identifier."
-    args_schema: Type[BaseModel] = ToolArgsWithIdentifier
-
-    def _run(self, identifier: str) -> int:
-        return self.kfinance_client.ticker(identifier).security_id

kfinance/tool_calling/get_trading_item_id_from_identifier.py

@@ -1,14 +0,0 @@
-from typing import Type
-
-from pydantic import BaseModel
-
-from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
-
-
-class GetTradingItemIdFromIdentifier(KfinanceTool):
-    name: str = "get_trading_item_id_from_identifier"
-    description: str = "Get the trading item id associated with an identifier."
-    args_schema: Type[BaseModel] = ToolArgsWithIdentifier
-
-    def _run(self, identifier: str) -> int:
-        return self.kfinance_client.ticker(identifier).trading_item_id