kensho-kfinance 2.7.0__py3-none-any.whl → 2.8.0__py3-none-any.whl

kfinance/tests/test_tools.py

@@ -9,14 +9,12 @@ from pytest import raises
 from requests_mock import Mocker
 import time_machine
 
-from kfinance.constants import (
-    BusinessRelationshipType,
-    Capitalization,
-    CompetitorSource,
-    SegmentType,
-    StatementType,
-)
 from kfinance.kfinance import Client, NoEarningsDataError
+from kfinance.models.business_relationship_models import BusinessRelationshipType
+from kfinance.models.capitalization_models import Capitalization
+from kfinance.models.competitor_models import CompetitorSource
+from kfinance.models.segment_models import SegmentType
+from kfinance.models.statement_models import StatementType
 from kfinance.tests.conftest import SPGI_COMPANY_ID, SPGI_SECURITY_ID, SPGI_TRADING_ITEM_ID
 from kfinance.tests.test_objects import MOCK_COMPANY_DB, MOCK_MERGERS_DB, ordered
 from kfinance.tool_calling import (
@@ -164,6 +162,7 @@ class TestGetCapitalizationFromIdentifier:
         requests_mock.get(
             url=f"https://kfinance.kensho.com/api/v1/market_cap/{SPGI_COMPANY_ID}/none/none",
             json={
+                "currency": "USD",
                 "market_caps": [
                     {
                         "date": "2024-04-10",
@@ -177,11 +176,16 @@ class TestGetCapitalizationFromIdentifier:
                         "tev": "147105066761.000000",
                         "shares_outstanding": 313099562,
                     },
-                ]
+                ],
             },
         )
 
-        expected_response = "| date       |   market_cap |\n|:-----------|-------------:|\n| 2024-04-10 |  1.32767e+11 |\n| 2024-04-11 |  1.32416e+11 |"
+        expected_response = {
+            "market_cap": [
+                {"2024-04-10": {"unit": "USD", "value": "132766738270.00"}},
+                {"2024-04-11": {"unit": "USD", "value": "132416066761.00"}},
+            ]
+        }
 
         tool = GetCapitalizationFromIdentifier(kfinance_client=mock_client)
         args = GetCapitalizationFromIdentifierArgs(
@@ -442,6 +446,7 @@ class TestPricesFromIdentifier:
             url=f"https://kfinance.kensho.com/api/v1/pricing/{SPGI_TRADING_ITEM_ID}/none/none/day/adjusted",
             # truncated response
             json={
+                "currency": "USD",
                 "prices": [
                     {
                         "date": "2024-04-11",
@@ -459,10 +464,29 @@ class TestPricesFromIdentifier:
                         "close": "417.810000",
                         "volume": "1182229",
                     },
-                ]
+                ],
             },
         )
-        expected_response = "| date       |   open |   high |    low |   close |      volume |\n|:-----------|-------:|-------:|-------:|--------:|------------:|\n| 2024-04-11 | 424.26 | 425.99 | 422.04 |  422.92 | 1.12916e+06 |\n| 2024-04-12 | 419.23 | 421.94 | 416.45 |  417.81 | 1.18223e+06 |"
+        expected_response = {
+            "prices": [
+                {
+                    "date": "2024-04-11",
+                    "open": {"value": "424.26", "unit": "USD"},
+                    "high": {"value": "425.99", "unit": "USD"},
+                    "low": {"value": "422.04", "unit": "USD"},
+                    "close": {"value": "422.92", "unit": "USD"},
+                    "volume": {"value": "1129158", "unit": "Shares"},
+                },
+                {
+                    "date": "2024-04-12",
+                    "open": {"value": "419.23", "unit": "USD"},
+                    "high": {"value": "421.94", "unit": "USD"},
+                    "low": {"value": "416.45", "unit": "USD"},
+                    "close": {"value": "417.81", "unit": "USD"},
+                    "volume": {"value": "1182229", "unit": "Shares"},
+                },
+            ]
+        }
 
         tool = GetPricesFromIdentifier(kfinance_client=mock_client)
         response = tool.run(GetPricesFromIdentifierArgs(identifier="SPGI").model_dump(mode="json"))

kfinance/tool_calling/get_advisors_for_company_in_transaction_from_identifier.py

@@ -2,8 +2,8 @@ from typing import Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import Permission
 from kfinance.kfinance import AdvisedCompany
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
 
 

kfinance/tool_calling/get_business_relationship_from_identifier.py

@@ -2,8 +2,9 @@ from typing import Type
 
 from pydantic import BaseModel
 
-from kfinance.constants import BusinessRelationshipType, Permission
 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
 
 

kfinance/tool_calling/get_capitalization_from_identifier.py

@@ -2,7 +2,8 @@ from datetime import date
 
 from pydantic import Field
 
-from kfinance.constants import Capitalization, Permission
+from kfinance.models.capitalization_models import Capitalization
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
 
 
@@ -29,8 +30,6 @@ class GetCapitalizationFromIdentifier(KfinanceTool):
         capitalization: Capitalization,
         start_date: str | None = None,
         end_date: str | None = None,
-    ) -> str:
+    ) -> dict:
         ticker = self.kfinance_client.ticker(identifier)
-        return getattr(ticker, capitalization.value)(
-            start_date=start_date, end_date=end_date
-        ).to_markdown()
+        return getattr(ticker, capitalization.value)(start_date=start_date, end_date=end_date)

kfinance/tool_calling/get_competitors_from_identifier.py

@@ -1,4 +1,5 @@
-from kfinance.constants import CompetitorSource, Permission
+from kfinance.models.competitor_models import CompetitorSource
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
 
 

kfinance/tool_calling/get_cusip_from_ticker.py

@@ -2,7 +2,7 @@ from typing import Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import Permission
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool
 
 

kfinance/tool_calling/get_earnings.py

@@ -2,8 +2,8 @@ from typing import Type
 
 from pydantic import BaseModel
 
-from kfinance.constants import Permission
 from kfinance.kfinance import NoEarningsDataError
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
 
 

kfinance/tool_calling/get_financial_line_item_from_identifier.py

@@ -2,7 +2,9 @@ from typing import Literal, Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import LINE_ITEM_NAMES_AND_ALIASES, PeriodType, Permission
+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
 
 

kfinance/tool_calling/get_financial_statement_from_identifier.py

@@ -2,7 +2,9 @@ from typing import Literal, Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import PeriodType, Permission, StatementType
+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
 
 

kfinance/tool_calling/get_history_metadata_from_identifier.py

@@ -2,7 +2,8 @@ from typing import Type
 
 from pydantic import BaseModel
 
-from kfinance.constants import HistoryMetadata, Permission
+from kfinance.models.permission_models import Permission
+from kfinance.models.price_models import HistoryMetadata
 from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
 
 

kfinance/tool_calling/get_info_from_identifier.py

@@ -2,7 +2,7 @@ from typing import Type
 
 from pydantic import BaseModel
 
-from kfinance.constants import Permission
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
 
 

kfinance/tool_calling/get_isin_from_ticker.py

@@ -2,7 +2,7 @@ from typing import Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import Permission
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool
 
 

kfinance/tool_calling/get_latest.py

@@ -2,7 +2,8 @@ from typing import Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import LatestPeriods, Permission
+from kfinance.models.date_and_period_models import LatestPeriods
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool
 
 

kfinance/tool_calling/get_latest_earnings.py

@@ -2,8 +2,8 @@ from typing import Type
 
 from pydantic import BaseModel
 
-from kfinance.constants import Permission
 from kfinance.kfinance import NoEarningsDataError
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
 
 

kfinance/tool_calling/get_merger_info_from_transaction_id.py

@@ -2,8 +2,8 @@ from typing import Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import Permission
 from kfinance.kfinance import MergerOrAcquisition
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool
 
 

kfinance/tool_calling/get_mergers_from_identifier.py

@@ -2,7 +2,7 @@ from typing import Type
 
 from pydantic import BaseModel
 
-from kfinance.constants import Permission
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
 
 

kfinance/tool_calling/get_n_quarters_ago.py

@@ -2,7 +2,8 @@ from typing import Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import Permission, YearAndQuarter
+from kfinance.models.date_and_period_models import YearAndQuarter
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool
 
 

kfinance/tool_calling/get_next_earnings.py

@@ -2,8 +2,8 @@ from typing import Type
 
 from pydantic import BaseModel
 
-from kfinance.constants import Permission
 from kfinance.kfinance import NoEarningsDataError
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
 
 

kfinance/tool_calling/get_prices_from_identifier.py

@@ -3,7 +3,8 @@ from typing import Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import Periodicity, Permission
+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
 
 
@@ -35,11 +36,11 @@ class GetPricesFromIdentifier(KfinanceTool):
         end_date: date | None = None,
         periodicity: Periodicity = Periodicity.day,
         adjusted: bool = True,
-    ) -> str:
+    ) -> 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,
-        ).to_markdown()
+        ).model_dump(mode="json")

kfinance/tool_calling/get_segments_from_identifier.py

@@ -2,7 +2,9 @@ from typing import Literal, Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import PeriodType, Permission, SegmentType
+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
 
 

kfinance/tool_calling/get_transcript.py

@@ -2,7 +2,7 @@ from typing import Type
 
 from pydantic import BaseModel, Field
 
-from kfinance.constants import Permission
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool
 
 

kfinance/tool_calling/resolve_identifier.py

@@ -2,7 +2,7 @@ from typing import Type
 
 from pydantic import BaseModel
 
-from kfinance.constants import Permission
+from kfinance.models.permission_models import Permission
 from kfinance.tool_calling.shared_models import KfinanceTool, ToolArgsWithIdentifier
 
 

kfinance/tool_calling/shared_models.py

@@ -3,8 +3,8 @@ from typing import Annotated, Any, Literal, Type
 from langchain_core.tools import BaseTool
 from pydantic import BaseModel, BeforeValidator, ConfigDict, Field
 
-from kfinance.constants import Permission
 from kfinance.kfinance import Client
+from kfinance.models.permission_models import Permission
 
 
 class KfinanceTool(BaseTool):

kfinance/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.7.0'
-__version_tuple__ = version_tuple = (2, 7, 0)
+__version__ = version = '2.8.0'
+__version_tuple__ = version_tuple = (2, 8, 0)

kensho_kfinance-2.7.0.dist-info/RECORD

@@ -1,54 +0,0 @@
-kensho_kfinance-2.7.0.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
-kensho_kfinance-2.7.0.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
-kfinance/CHANGELOG.md,sha256=wNB99rvUBZsLmuCxq9ZtzvNpzeze8YmFz2HMdue3Di4,2175
-kfinance/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/batch_request_handling.py,sha256=G9rhpgQaCdb5C1dsfuJip8383iszibcOJ5k8gxld-tQ,5001
-kfinance/constants.py,sha256=Zh7ruf-gFR6twCy5CUjOCgT_cGX-rgFdmR84AkcztYw,49453
-kfinance/fetch.py,sha256=sDxO3loGNcn2aT8azXR6MlHHLyjYoWIKK1HpN2-fYu0,27682
-kfinance/kfinance.py,sha256=MvEgcSDSiws3beJefQbOh3n8DdC6Wf33wiwf3Jfu6Mg,73194
-kfinance/mcp.py,sha256=MbktclVfBOEwfe-eR7kPaTXopMJmn_8RMlf4Jx5CXKU,3689
-kfinance/meta_classes.py,sha256=ulRNnWZ4P0HURs8XPzCTsJ3SYbvnT4SXyG4dIuITxAo,21766
-kfinance/prompt.py,sha256=PtVB8c_FcSlVdyGgByAnIFGzuUuBaEjciCqnBJl1hSQ,25133
-kfinance/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/pydantic_models.py,sha256=avpbPqwrAyLqsCbrmFpK_B8_fj1nPlBHrnPxRcBaSkE,774
-kfinance/server_thread.py,sha256=jUnt1YGoYDkqqz1MbCwd44zJs1T_Z2BCgvj75bdtLgA,2574
-kfinance/version.py,sha256=t0tYtjmuqfTGJQNs3pmrehzkGSiJlTwAuPRgzmcsAVU,511
-kfinance/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/tests/conftest.py,sha256=dhL_RSc-af3j-2_UrAGRE9mxgcbjuIRtj08DTx79pQc,1123
-kfinance/tests/scratch.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/tests/test_batch_requests.py,sha256=2A0XnDDDSPkq0-BuiRryZx8b9_jBDtjYd2kWxFVyRew,10140
-kfinance/tests/test_client.py,sha256=_OJ8fZ14aa7Oj2znheuRIRKz7FyQLqwkhWexEZetxmg,3855
-kfinance/tests/test_example_notebook.py,sha256=XHwDKw2avyMonTmi3snCcFWNfZhEJOkpBGOZNrMLrhk,6470
-kfinance/tests/test_fetch.py,sha256=mIj61dd843p3D1qtTAO60rZi6Rax0NgefOTTiBFrQcQ,17887
-kfinance/tests/test_group_objects.py,sha256=SoMEZmkG4RYdgWOAwxLHHtzIQho92KM01YbQXPUg578,1689
-kfinance/tests/test_objects.py,sha256=YlpxjlT1kJsDf4SgTZkhhthODwCnwNukJF_wvi11p3A,40805
-kfinance/tests/test_tools.py,sha256=nq6xfnUYBm4uF_iGe2iLv6SXFesbEy4QyBk4ldXyhPk,30097
-kfinance/tool_calling/README.md,sha256=omJq7Us6r4U45QB7hRpLjRJ5BMalCkZkh4uXBjTbJXc,2022
-kfinance/tool_calling/__init__.py,sha256=UmtbtG6PvQHB1fInEL-K5q0kPHL__zTY9wzaPRSp1wg,2174
-kfinance/tool_calling/get_advisors_for_company_in_transaction_from_identifier.py,sha256=rrUVesFG3EpdVnvML42o6apJyBfWOBk0iYydJgIZaig,1615
-kfinance/tool_calling/get_business_relationship_from_identifier.py,sha256=vILN4k2NGCIrpgWiT_p7CLwDv_uQf9qXwojmQwDRsJo,1480
-kfinance/tool_calling/get_capitalization_from_identifier.py,sha256=7n52UH0oug6KspPxCQsRinb6WPC4M5UNK1CFhQxKAaE,1529
-kfinance/tool_calling/get_competitors_from_identifier.py,sha256=RZ1ngeeZee12GOKUvw1rpzij9A55Zfs3MTt6O-DC98M,1096
-kfinance/tool_calling/get_cusip_from_ticker.py,sha256=P4J2JS0_jwmfBWD9k-URlJ0gPFsgTkglivN-d3fA9Ek,652
-kfinance/tool_calling/get_earnings.py,sha256=53mpdno7uaVMQVQXC_IXYEGvBh2kM7e41SFxI9LG--A,1230
-kfinance/tool_calling/get_financial_line_item_from_identifier.py,sha256=iQywFZzXQdvL3oSWPHZJ6v1kifR27tsHLcXa6089Wls,2161
-kfinance/tool_calling/get_financial_statement_from_identifier.py,sha256=4nJvQBaZZpD9-cKBONEimicUsQxIftFfdVj7rRqdUck,1914
-kfinance/tool_calling/get_history_metadata_from_identifier.py,sha256=N-ZXYMT0YGIcTmCEAKgs5IK134WKFeuVzrGyPYIliXM,734
-kfinance/tool_calling/get_info_from_identifier.py,sha256=XRan7nKa0FQuBF0i8UmoN2E0FOMEx34N8H-El4J51E0,772
-kfinance/tool_calling/get_isin_from_ticker.py,sha256=iy4p8dhOpkooPZP8BPQRijsZbDbuAf9WyV5t8zBGMi8,646
-kfinance/tool_calling/get_latest.py,sha256=CHtR8MvUdOxI63kWVWFONUaqlHPhSrE9qv96RRCJsiw,792
-kfinance/tool_calling/get_latest_earnings.py,sha256=lUahH0G-QbxxeN4ClF-ETrMACFesw5UXOl9pnssDgzM,1182
-kfinance/tool_calling/get_merger_info_from_transaction_id.py,sha256=uTtUFMtKrN53BxZ53s_HlTyyc4ToO1qIPFUts6IQFu8,3150
-kfinance/tool_calling/get_mergers_from_identifier.py,sha256=Av86oG4Rf4eUYG3aHIzIMwJEkrxKR1CqRYLPnCQN5po,1710
-kfinance/tool_calling/get_n_quarters_ago.py,sha256=R-_Wn-VUYABb7CPD2OQ_xauMAOZoYXW0FPw6ccvw6Ho,719
-kfinance/tool_calling/get_next_earnings.py,sha256=O7bIXqJmvxgBZZ9jjcvN2WGy2KIsBe6YegnymiYJy-E,1162
-kfinance/tool_calling/get_prices_from_identifier.py,sha256=4yTEPWTMqfUfU6JdsD_TQJLEFTNji0wic-8oXtdSqVY,1890
-kfinance/tool_calling/get_segments_from_identifier.py,sha256=-6I5pK_VSNxszUuQX6ne9zr7HFwaeWCFMddmJ3PYA_g,1873
-kfinance/tool_calling/get_transcript.py,sha256=2Vzab47kMw1288AubFXwhNGHtodmy_n2itITgk5szOg,767
-kfinance/tool_calling/prompts.py,sha256=Yw1DJIMh90cjL-8q6_RMRiSjCtFDXvJAy7QiV5_uAU8,911
-kfinance/tool_calling/resolve_identifier.py,sha256=_XEfGtDEB5tnAnseyQaugn4AuNsy6wZe5f-QOh8myko,632
-kfinance/tool_calling/shared_models.py,sha256=2KUY7PLFO-89Y6pYyDNbF8ub8KgWkay16683u8Wvf8Y,3731
-kensho_kfinance-2.7.0.dist-info/METADATA,sha256=MGykZUh-nhnOLxDtjsY_rgKZX73bGLOJ5vg54yO_pY0,6197
-kensho_kfinance-2.7.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kensho_kfinance-2.7.0.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
-kensho_kfinance-2.7.0.dist-info/RECORD,,