kensho-kfinance 3.2.8__py3-none-any.whl → 3.2.10__py3-none-any.whl

{kensho_kfinance-3.2.8.dist-info → kensho_kfinance-3.2.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 3.2.8
+Version: 3.2.10
 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-3.2.8.dist-info → kensho_kfinance-3.2.10.dist-info}/RECORD

@@ -1,11 +1,11 @@
-kensho_kfinance-3.2.8.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
-kensho_kfinance-3.2.8.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
-kfinance/CHANGELOG.md,sha256=mlG5-P5h1CuVZr5J_PXzbIp6ZKyi025VsE2ZkLbPj3g,3167
+kensho_kfinance-3.2.10.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
+kensho_kfinance-3.2.10.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
+kfinance/CHANGELOG.md,sha256=3mgDixfg0ojmEr3D36QnfaFd8YZD5zeHkjA3NHBRm08,3388
 kfinance/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 kfinance/conftest.py,sha256=FIZNQyfFbldyVmzaLfWbnMGh6RiC4MZwOVax6815_Ms,3754
 kfinance/mcp.py,sha256=LTzCIlqsDKRD-0Xcpa_P99-JmJ8duAneO_-GzM43kjw,424
 kfinance/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/version.py,sha256=8FMm_QcLlh92f9OS9bkbD2zvlUgR6L3RMWK7bQzgvMo,704
+kfinance/version.py,sha256=0Do_CqGpGkuLSWuqbzGC46drHfwvUEjSDoKQNrc0rss,706
 kfinance/client/README.md,sha256=DA5vg4uz1JmJNiqvYywrj46YNhOr584WO8L83Ysx_Mk,372
 kfinance/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/client/batch_request_handling.py,sha256=opwJJAU2JtqH-s4vt8wRqhH34MiU4tQP6Ng7K6b3upA,6561
@@ -43,9 +43,9 @@ kfinance/domains/capitalizations/tests/test_capitalization_tools.py,sha256=H43ml
 kfinance/domains/companies/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/companies/company_identifiers.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/companies/company_models.py,sha256=Ny0o5lB5e1gN3bSj8bVbfqg6ktgJrwn9-58sKO1bmXs,5060
-kfinance/domains/companies/company_tools.py,sha256=Vuyegx0fTM8snOj2Ywou2cgy8puxh1Ry2zTbT5i9ltk,8885
+kfinance/domains/companies/company_tools.py,sha256=PGBKlOUGCCK6eqUK9EbiSznBDnbu2YhgMwnqu5WkoJo,9171
 kfinance/domains/companies/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/domains/companies/tests/test_company_tools.py,sha256=6Gl3Sjg80Qri-TrP1UB8RgmgQ8LOAhVZ1nxevAZJAc4,5377
+kfinance/domains/companies/tests/test_company_tools.py,sha256=ijZF6tWswvtD9YpjtGAPsS76nyOf6aaNPB_u_v-EAwQ,5587
 kfinance/domains/competitors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/competitors/competitor_models.py,sha256=HAEn2AzKZNusclsFzyAufpS-627RfRGL4Vw1AiT_Ek0,747
 kfinance/domains/competitors/competitor_tools.py,sha256=k1zyr03gbnIrQ8IaENaZlVE8RiiW_77MqnArWzKa02M,2524
@@ -62,7 +62,7 @@ kfinance/domains/earnings/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm
 kfinance/domains/earnings/tests/test_earnings_tools.py,sha256=qGhdWI1s4uEjF6XtFC0f1nlAths1H6xfym-iJyBpwBo,6998
 kfinance/domains/line_items/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/line_items/line_item_models.py,sha256=6J_9cko9nZ3OAGSC7OMGEMQW8dkXjRLWn4_2BjtHemU,50969
-kfinance/domains/line_items/line_item_tools.py,sha256=XYIo2-qnUdpDuKKnS5yweVkd_JGnMaXORhBdRRbHYko,4990
+kfinance/domains/line_items/line_item_tools.py,sha256=lxvhYbnZKapIf2nIfdtVqXiDswJoeU5XxMOAGUeb8cI,5192
 kfinance/domains/line_items/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/line_items/tests/test_line_item_tools.py,sha256=vgxJsPbQG1msXZKTfpyHSzUfhw0GvfxZ041T7J-56hU,5499
 kfinance/domains/mergers_and_acquisitions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -78,12 +78,12 @@ kfinance/domains/prices/tests/test_price_models.py,sha256=PWGqbR9aCys2ldHZMF5anM
 kfinance/domains/prices/tests/test_price_tools.py,sha256=xNuzAzeu1KuhkB0xF2oIYLVZub9uDg8VLRNmKq-iJ3s,6426
 kfinance/domains/segments/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/segments/segment_models.py,sha256=CEZK_B9WM0eppsOpjUbt-ILIcLkQMYgVq4TAx_SrPlc,262
-kfinance/domains/segments/segment_tools.py,sha256=DC2mgMwR-y6saN_hv6KpfPMe5j7MT1UOn2rH5snDHWg,4389
+kfinance/domains/segments/segment_tools.py,sha256=3zOAn0tayBykTNiprwn32hH-Q0sNJrPwMhnoGSs6yYo,4654
 kfinance/domains/segments/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/segments/tests/test_segment_tools.py,sha256=Qmh1SpGwVGUhe_r1b4ZpBesu_yN2hq2wiM3z1wmmY6M,4975
 kfinance/domains/statements/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/statements/statement_models.py,sha256=f7jEejuvMbsW9paqHIJ19DKUX3XL_qzf74jZBKDamfE,328
-kfinance/domains/statements/statement_tools.py,sha256=G3VbRHdyFZyNiz2ZFTCJeytBt8F2KVwi_YlUgT4A4WQ,4960
+kfinance/domains/statements/statement_tools.py,sha256=RHNQmv4yExXHHxokwgxzLuYG9iCfZuOKRRThm-K3mOQ,5162
 kfinance/domains/statements/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/statements/tests/test_statement_tools.py,sha256=mraxvm6tpd-SFRIcco9dKRR2VC8kg1LlYcggBBocLBA,6052
 kfinance/integrations/README.md,sha256=GalSN11UHzbLfcNzKAlObNbw5XqMKVXSVzzGlryM3zc,320
@@ -106,9 +106,9 @@ kfinance/integrations/tool_calling/static_tools/tests/__init__.py,sha256=47DEQpj
 kfinance/integrations/tool_calling/static_tools/tests/test_get_lastest.py,sha256=MN2gx-Hhvfvwh9v6eL_d5Yrbb054q7How1tPdYQlPvg,1149
 kfinance/integrations/tool_calling/static_tools/tests/test_get_n_quarters_ago.py,sha256=BjlTgaNrI5Tv7SpTWz0Q8WucDLcQviCqVH2zgLpNpcM,856
 kfinance/integrations/tool_calling/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/integrations/tool_calling/tests/test_tool_calling_models.py,sha256=FIusHU4kFmVPuh31Kn57_356tNNVMGTbHApMUFJOaGM,2724
+kfinance/integrations/tool_calling/tests/test_tool_calling_models.py,sha256=5L8TpSVJmrjNzGcnERorpfeyrgLND_DL46ld5hVlcNw,2933
 kfinance/models/permission_models.py,sha256=G0so8ZOsD1YDsCM4he0z5R9M_shUbSRwD3hUDJdqZl0,635
-kensho_kfinance-3.2.8.dist-info/METADATA,sha256=mBpdg_bsXThcron1Z21GrGQcxE7QIJqX6pWNx34ojJE,6197
-kensho_kfinance-3.2.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kensho_kfinance-3.2.8.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
-kensho_kfinance-3.2.8.dist-info/RECORD,,
+kensho_kfinance-3.2.10.dist-info/METADATA,sha256=u2l7KD1wRwk071OyjYEXqr3N6ZgcvZNRPZQG0OjAqkg,6198
+kensho_kfinance-3.2.10.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kensho_kfinance-3.2.10.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
+kensho_kfinance-3.2.10.dist-info/RECORD,,

kfinance/CHANGELOG.md

@@ -1,7 +1,12 @@
 # Changelog
+# 3.2.10
+- Add CIQ company_id to GetInfoFromIdentifiersResp
+
+# v3.2.9
+- Update tool descriptions for line items, segments, and statements to mention that all period-based inputs and outputs refer only to the calendar year.
 
 # v3.2.8
-- Added support for None to LineItemResponse & empty behavior for line items, segments, and statements
+- Add support for None to LineItemResponse & empty behavior for line items, segments, and statements
 
 # v3.2.7
 - Fix validator for UnifiedIdTripleResponse

kfinance/domains/companies/company_tools.py

@@ -5,7 +5,11 @@ from pydantic import BaseModel
 
 from kfinance.client.batch_request_handling import Task, process_tasks_in_thread_pool_executor
 from kfinance.client.permission_models import Permission
-from kfinance.domains.companies.company_models import CompanyDescriptions, CompanyOtherNames
+from kfinance.domains.companies.company_models import (
+    COMPANY_ID_PREFIX,
+    CompanyDescriptions,
+    CompanyOtherNames,
+)
 from kfinance.integrations.tool_calling.tool_calling_models import (
     KfinanceTool,
     ToolArgsWithIdentifiers,
@@ -20,7 +24,7 @@ class GetInfoFromIdentifiersResp(ToolRespWithErrors):
 class GetInfoFromIdentifiers(KfinanceTool):
     name: str = "get_info_from_identifiers"
     description: str = dedent("""
-        Get the information associated with a list of identifiers. 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.
+        Get the information associated with a list of identifiers. 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, HQ country iso code, and CIQ company_id.
 
         - When possible, pass multiple identifiers in a single call rather than making multiple calls.
     """).strip()
@@ -44,7 +48,8 @@ class GetInfoFromIdentifiers(KfinanceTool):
                     "zip_code": "10041-0001",
                     "state": "New York",
                     "country": "United States",
-                    "iso_country": "USA"
+                    "iso_country": "USA",
+                    "company_id": "C_21719"
                 }
             },
             "errors": [['No identification triple found for the provided identifier: NON-EXISTENT of type: ticker']
@@ -65,6 +70,10 @@ class GetInfoFromIdentifiers(KfinanceTool):
         info_responses: dict[str, dict] = process_tasks_in_thread_pool_executor(
             api_client=api_client, tasks=tasks
         )
+
+        for identifier, id_triple in id_triple_resp.identifiers_to_id_triples.items():
+            info_responses[identifier]["company_id"] = f"{COMPANY_ID_PREFIX}{id_triple.company_id}"
+
         return GetInfoFromIdentifiersResp(
             results=info_responses, errors=list(id_triple_resp.errors.values())
         )

kfinance/domains/companies/tests/test_company_tools.py

@@ -2,6 +2,7 @@ from requests_mock import Mocker
 
 from kfinance.client.kfinance import Client
 from kfinance.conftest import SPGI_COMPANY_ID
+from kfinance.domains.companies.company_models import COMPANY_ID_PREFIX
 from kfinance.domains.companies.company_tools import (
     GetCompanyDescriptionFromIdentifiers,
     GetCompanyDescriptionFromIdentifiersResp,
@@ -23,7 +24,11 @@ class TestGetInfoFromIdentifiers:
         THEN we get back info for SPGI and an error for the non-existent company
         """
 
-        info_resp = {"name": "S&P Global Inc.", "status": "Operating"}
+        info_resp = {
+            "name": "S&P Global Inc.",
+            "status": "Operating",
+            "company_id": f"{COMPANY_ID_PREFIX}{SPGI_COMPANY_ID}",
+        }
         expected_response = GetInfoFromIdentifiersResp.model_validate(
             {
                 "results": {"SPGI": info_resp},
@@ -32,6 +37,7 @@ class TestGetInfoFromIdentifiers:
                 ],
             }
         )
+        del info_resp["company_id"]
         requests_mock.get(
             url=f"https://kfinance.kensho.com/api/v1/info/{SPGI_COMPANY_ID}",
             json=info_resp,

kfinance/domains/line_items/line_item_tools.py

@@ -43,6 +43,7 @@ class GetFinancialLineItemFromIdentifiers(KfinanceTool):
 
         - When possible, pass multiple identifiers in a single call rather than making multiple calls.
         - To fetch the most recent value for the line item, leave start_year, start_quarter, end_year, and end_quarter as None.
+        - The tool accepts arguments in calendar years, and all outputs will be presented in terms of calendar years. Please note that these calendar years may not align with the company's fiscal year.
 
         Example:
         Query: "What are the revenues of Lowe's and Home Depot?"

kfinance/domains/segments/segment_tools.py

@@ -1,3 +1,4 @@
+from textwrap import dedent
 from typing import Literal, Type
 
 from pydantic import BaseModel, Field
@@ -30,7 +31,11 @@ class GetSegmentsFromIdentifiersResp(ToolRespWithErrors):
 
 class GetSegmentsFromIdentifiers(KfinanceTool):
     name: str = "get_segments_from_identifiers"
-    description: str = "Get the templated segments associated with a list of identifiers."
+    description: str = dedent("""
+        Get the templated segments associated with a list of identifiers.
+
+        - The tool accepts arguments in calendar years, and all outputs will be presented in terms of calendar years. Please note that these calendar years may not align with the company's fiscal year.
+    """).strip()
     args_schema: Type[BaseModel] = GetSegmentsFromIdentifiersArgs
     accepted_permissions: set[Permission] | None = {Permission.SegmentsPermission}
 

kfinance/domains/statements/statement_tools.py

@@ -35,6 +35,7 @@ class GetFinancialStatementFromIdentifiers(KfinanceTool):
         Get a financial statement associated with a group of identifiers.
 
         - To fetch the most recent value for the statement, leave start_year, start_quarter, end_year, and end_quarter as None.
+        - The tool accepts arguments in calendar years, and all outputs will be presented in terms of calendar years. Please note that these calendar years may not align with the company's fiscal year.
 
         Example:
         Query: "Fetch the balance sheets of BAC and GS for 2024"

kfinance/integrations/tool_calling/tests/test_tool_calling_models.py

@@ -7,6 +7,7 @@ from requests_mock import Mocker
 
 from kfinance.client.kfinance import Client
 from kfinance.conftest import SPGI_COMPANY_ID
+from kfinance.domains.companies.company_models import COMPANY_ID_PREFIX
 from kfinance.domains.companies.company_tools import (
     GetInfoFromIdentifiers,
     GetInfoFromIdentifiersResp,
@@ -25,7 +26,11 @@ class TestGetEndpointsFromToolCallsWithGrounding:
         """
 
         # truncated from the original
-        resp_data = {"name": "S&P Global Inc.", "status": "Operating"}
+        resp_data = {
+            "name": "S&P Global Inc.",
+            "status": "Operating",
+            "company_id": f"{COMPANY_ID_PREFIX}{SPGI_COMPANY_ID}",
+        }
         resp_endpoint = [
             "https://kfinance.kensho.com/api/v1/ids",
             "https://kfinance.kensho.com/api/v1/info/21719",
@@ -34,7 +39,7 @@ class TestGetEndpointsFromToolCallsWithGrounding:
             "data": GetInfoFromIdentifiersResp.model_validate({"results": {"SPGI": resp_data}}),
             "endpoint_urls": resp_endpoint,
         }
-
+        del resp_data["company_id"]
         requests_mock.get(
             url=f"https://kfinance.kensho.com/api/v1/info/{SPGI_COMPANY_ID}",
             json=resp_data,

kfinance/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '3.2.8'
-__version_tuple__ = version_tuple = (3, 2, 8)
+__version__ = version = '3.2.10'
+__version_tuple__ = version_tuple = (3, 2, 10)
 
 __commit_id__ = commit_id = None