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

{kensho_kfinance-2.9.0.dist-info → kensho_kfinance-3.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.9.0
+Version: 3.0.0
 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.0.0.dist-info/RECORD

@@ -0,0 +1,110 @@
+kensho_kfinance-3.0.0.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
+kensho_kfinance-3.0.0.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
+kfinance/CHANGELOG.md,sha256=E0r1EJ4GGj2Q77ghjimkpNlaR9GhZmICIJP_DtZ5Xfs,2342
+kfinance/__init__.py,sha256=k3nXA7nYUeLDrs3B0E_NcVOh_LRIfLSXGr9X78HNHeg,63
+kfinance/conftest.py,sha256=JyBWZuJopwN9MuisFVS_U8jd9L-UU74d-ALUTa43J1Q,1599
+kfinance/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/version.py,sha256=feOY2rjYM8_-oXmp5ErPlMe-6zWTpyiw538tUrvFyEA,511
+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
+kfinance/client/fetch.py,sha256=g06-j_pOl2PeX7_E-kdeEG-xcudsDIpbRupZ6J0wbo0,27856
+kfinance/client/industry_models.py,sha256=ydB_cTIsNsfCUeaO7K2qqLUuHdG6WfUCoAzBigKVV8M,243
+kfinance/client/kfinance.py,sha256=BwywHwYvw1PEO3wvecKaRQGYdHdIkM0yxAVdTEgRjLM,72693
+kfinance/client/meta_classes.py,sha256=eJP09HQPQIp7H5DEFbuCKd1BZajFkzf6WpDbEnoXTuI,21415
+kfinance/client/permission_models.py,sha256=z6MKY7Zf7StPKwsucsoVqltUesicU6MC6rxRGmlRwZI,557
+kfinance/client/server_thread.py,sha256=jUnt1YGoYDkqqz1MbCwd44zJs1T_Z2BCgvj75bdtLgA,2574
+kfinance/client/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/client/models/currency_models.py,sha256=JfDZf-nATCyjThBw-Ky2BNvM-n2oHepBLIHMCIyCRUE,19201
+kfinance/client/models/date_and_period_models.py,sha256=B508v1SLy_mbSSuSbPz41xeFNRAeBFv41gJSlaXyHnU,1062
+kfinance/client/models/decimal_with_unit.py,sha256=lfBvOQDk1cdWnqRh7oZoXe3_TbjNsbaV31KyosH_OoY,2911
+kfinance/client/models/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/client/models/tests/test_decimal_with_unit.py,sha256=7WlmVXFOFNHFqwsvXQvcgyPfa6noRm3-mLTcXz4GvRs,2202
+kfinance/client/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/client/tests/test_batch_requests.py,sha256=KcE5rNJHBP27xaZOmwg8cVyUMZAAPt6jDiCeq94wUUk,11661
+kfinance/client/tests/test_client.py,sha256=GlK89ZOGL9bwrAUFUk8nua2ooKt0JYm7o_rpAfajFXA,4312
+kfinance/client/tests/test_fetch.py,sha256=S0-HlF2o1dQRHVUCw26hmefDWKnqRww3hOoo8Z34ELU,17726
+kfinance/client/tests/test_group_objects.py,sha256=wb7MEyGm-Qya3CXWM5Xz3kUhKFWdHT8FF3cQcjt1WxQ,1696
+kfinance/client/tests/test_objects.py,sha256=m7wS9vr7WrY4AI0Ub9z6Ml9iOuo303ficSYlImhR_EU,42747
+kfinance/domains/README.md,sha256=ehD15VwLupdXbz5M7hHUI7Y-2SCGxaP5W7Q4NuMcN64,664
+kfinance/domains/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/business_relationships/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/business_relationships/business_relationship_models.py,sha256=6uJKR7pfPBwlfn8YLuZOt7Jagg0Gv1bHefXrOJ9Ef20,1080
+kfinance/domains/business_relationships/business_relationship_tools.py,sha256=H5BPb7PLY6feq-gpSGbtrknpuTAfAC_EFYFpF8b0w5Q,2929
+kfinance/domains/business_relationships/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/business_relationships/tests/test_business_relationship_tools.py,sha256=HhyZ4DODnPOTfSckxkTfQbkL4yKkDwFh-VBmDoETyiY,2189
+kfinance/domains/capitalizations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/capitalizations/capitalization_models.py,sha256=dzPYRaDTuP6X2gqRhOP-8TaUCThYAi2Z4WH0y_19ZeY,3360
+kfinance/domains/capitalizations/capitalization_tools.py,sha256=lcXX_Vj50LEtjkeO8AKt-Gtt6tiRRTTzupKSoIPJQTo,3636
+kfinance/domains/capitalizations/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/capitalizations/tests/test_capitalization_models.py,sha256=SSFxEVnSLvuNjOK-gx4I3OCHso80OA37zOLmiHJhsro,3143
+kfinance/domains/capitalizations/tests/test_capitalization_tools.py,sha256=pJ8u5aO3K2Me9_9p8_gVaREv7qTtYlLzJgE2_-H5eYA,3299
+kfinance/domains/companies/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/companies/company_identifiers.py,sha256=nSscL8WlpHdCAPlminTiFfh-K4VYnJULZtbDmvg18yw,6207
+kfinance/domains/companies/company_models.py,sha256=cC3MluvkkiAVfg-IkVwI3NLyX7PvJ7Gpr-IIK_eB7Zk,637
+kfinance/domains/companies/company_tools.py,sha256=5n3BsSo3l4xSu85RwlOQWtrUMJa4jZGtmSTWKo81qNo,2595
+kfinance/domains/companies/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/companies/tests/test_company_tools.py,sha256=iJ82TfzeSm13B9FN7WabJh-49Zu686D-y_UN9LnbRW0,1028
+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=fHRezFZpWMS6r3BcFFTfAfhGx28MeExjTHDi55H67_k,2496
+kfinance/domains/competitors/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/competitors/tests/test_competitor_tools.py,sha256=A32zVmVfYFd643PxOFrQh-iAEnt72g4d-LJIw5AZGe4,1863
+kfinance/domains/cusip_and_isin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/cusip_and_isin/cusip_and_isin_tools.py,sha256=9ehO2jSuD6hDf3Cq72PKsJKDHME6-D9KJ96UqmU12YA,2943
+kfinance/domains/cusip_and_isin/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/cusip_and_isin/tests/test_cusip_and_isin_tools.py,sha256=-PyopFw7HqJ6_t6UWE5hVVNqDpkjQ7uj5iYaXIgaOrk,2211
+kfinance/domains/earnings/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/earnings/earning_models.py,sha256=3iPnjx3n511wqwSVB9_FMJ1ceCgIURnKpc3hwr9fIjY,1197
+kfinance/domains/earnings/earning_tools.py,sha256=2W-OzGljXpVmoiLUOwLDPBCAVybvIZ77TUPLpyUe62A,6446
+kfinance/domains/earnings/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/earnings/tests/test_earnings_tools.py,sha256=nKoYTG2bh7-ySoYGx0EXN68GHjrq-ziW5KVyiTTQfKk,6668
+kfinance/domains/line_items/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/line_items/line_item_models.py,sha256=JIdoSYxoJDQVkmqUK6_ABpb6lULXRvrCDJGiKL6kRhE,45399
+kfinance/domains/line_items/line_item_tools.py,sha256=7WJVuvKn6nOgraEd-YhhYB_a5KsyqosY6-LC1JSzjlA,4805
+kfinance/domains/line_items/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/line_items/tests/test_line_item_tools.py,sha256=aJxyDyW--1kyNVtjy2uGVou6NCTiVbypsFTsnvW-GVQ,3441
+kfinance/domains/mergers_and_acquisitions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/mergers_and_acquisitions/merger_and_acquisition_tools.py,sha256=FZ4sa8iBzSLYuteuv0jRazNR2poJcw8LxTPLwrptaKM,7500
+kfinance/domains/mergers_and_acquisitions/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/mergers_and_acquisitions/tests/test_merger_and_acquisition_tools.py,sha256=TyWhQ0o6Wtwl8PlLa03eEdY0ypyvwWlwi3FRcWdISnw,5493
+kfinance/domains/prices/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/prices/price_models.py,sha256=SG0vZk__IpuxBbfC-1OuL3iezBKE9eFwyo131dfY0kI,2163
+kfinance/domains/prices/price_tools.py,sha256=AL2TIFR-fk13vz03EjgCf3DmXyyXTsd3-3kLp3RNG6E,6587
+kfinance/domains/prices/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/prices/tests/test_price_models.py,sha256=PWGqbR9aCys2ldHZMF5anMXsSYEVOjgygfpxLcLVKL8,2400
+kfinance/domains/prices/tests/test_price_tools.py,sha256=Zj1b8pN1oJD1mjd7pbj0wsnWoDpUWEVW9jXUn8yn3UE,5274
+kfinance/domains/segments/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/segments/segment_models.py,sha256=GSJhK1HmbMmwRDFmrDTZzx8aYrAaHN13IJ0J9GTBn9Y,145
+kfinance/domains/segments/segment_tools.py,sha256=6JzR0na6vi259EeQ8FwXguHI8fsF_T5Ag7Y-_KAgP3M,3845
+kfinance/domains/segments/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/segments/tests/test_segment_tools.py,sha256=CKhRdtuyxhkM5grTtZF12XkJ8rkISVufpUXgq5qru4U,3024
+kfinance/domains/statements/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/statements/statement_models.py,sha256=RmclTeyahCODUP0-KgZZZequFgQ2pUQ8cdfHI96c9vA,207
+kfinance/domains/statements/statement_tools.py,sha256=69L5lknrYmostd0ROqEskKMGZ2N4AIvQPHG6_4WfUjs,4560
+kfinance/domains/statements/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/domains/statements/tests/test_statement_tools.py,sha256=O2fzCLmp98jxLD6cl16l65PvGYqa-_fQClayZzMOJxI,3015
+kfinance/integrations/README.md,sha256=GalSN11UHzbLfcNzKAlObNbw5XqMKVXSVzzGlryM3zc,320
+kfinance/integrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/integrations/mcp/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/integrations/mcp/mcp.py,sha256=9Wja-FvXZ-zK9iNRJmma3nGZ1r2VhRU1cVTxZ6BGLeE,3729
+kfinance/integrations/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/integrations/tests/test_example_notebook.py,sha256=NrqYFn_XyOn0YlV9QYEnNMBB7LEkg70pP1eqiLGxcBE,6529
+kfinance/integrations/tool_calling/README.md,sha256=TSk-AJddoEctzc0HXQvGNac2CckbnWxHcRDtEifSe1w,2029
+kfinance/integrations/tool_calling/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/integrations/tool_calling/all_tools.py,sha256=MbvAZX2yEyovGtBNcr5f6n2G_lV5Zc9nnSn7xgH3zjQ,2115
+kfinance/integrations/tool_calling/prompts.py,sha256=cLslVoubJyuh4W2-Eeok2dLOV4R7wUQGCu1HeQ1kNQo,1005
+kfinance/integrations/tool_calling/tool_calling_models.py,sha256=lb6r_1ULIA9RA5YsC9VLCY2kBwGrykx4UI0uDvlCZkM,5300
+kfinance/integrations/tool_calling/static_tools/README.md,sha256=lWQWdLY1tkGxqE8o4f61gc-RCX0doaCnZM0GmcNO6Jo,97
+kfinance/integrations/tool_calling/static_tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/integrations/tool_calling/static_tools/get_latest.py,sha256=pSLjofq9E6cQqGSFC73KmVpLATk9t5e-dUChsRmYUIQ,883
+kfinance/integrations/tool_calling/static_tools/get_n_quarters_ago.py,sha256=e29Mln2ExFZQwXLQmIrIk6eZToPI_IcfEMiVInR-NLU,810
+kfinance/integrations/tool_calling/static_tools/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/integrations/tool_calling/static_tools/tests/test_get_lastest.py,sha256=26CpdDcb-Ai3w-6qPVRRFPdlT2EKAFuOWkIRhxvb_Fk,989
+kfinance/integrations/tool_calling/static_tools/tests/test_get_n_quarters_ago.py,sha256=r7wtp7ttcJkKi2DQd42nzjfSXcpZAL97SrbltnjHuEI,775
+kfinance/integrations/tool_calling/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/integrations/tool_calling/tests/test_tool_calling_models.py,sha256=PWNNHaF7mFDZXXfwf4o5Hdemvr8VWl71ODHddr0FMwA,2596
+kensho_kfinance-3.0.0.dist-info/METADATA,sha256=IEoMmqwKpotcwZmC_vn2vYmlRhIMBtiqIRk52PSeHJY,6202
+kensho_kfinance-3.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kensho_kfinance-3.0.0.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
+kensho_kfinance-3.0.0.dist-info/RECORD,,

kfinance/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v3.0.0
+- Add tool calls that accept lists of identifiers.
+
 ## v2.9.0
 - Limit FastMCP version
 

kfinance/__init__.py

@@ -0,0 +1 @@
+from kfinance.integrations.mcp.mcp import run_mcp  # noqa:F401

kfinance/client/README.md

@@ -0,0 +1,9 @@
+# Client
+
+Client contains the main Kfinance `Client` class from `kfinance.py`
+and the lower level `KFinanceApiClient` from `fetch.py`. It also
+includes the objects like `Company` on which the `Client` operates 
+and related helpers like batch processing functionality. 
+
+It may at some point make sense to factor out objects and fetch 
+functions into their related domains.

kfinance/{batch_request_handling.py → client/batch_request_handling.py}

@@ -1,11 +1,12 @@
 from concurrent.futures import Future
+from dataclasses import dataclass, field
 import functools
 import threading
-from typing import Any, Callable, Iterable, Protocol, Sized, Type, TypeVar
+from typing import Any, Callable, Hashable, Iterable, Protocol, Sized, Type, TypeVar
 
 from requests.exceptions import HTTPError
 
-from .fetch import KFinanceApiClient
+from kfinance.client.fetch import KFinanceApiClient
 
 
 T = TypeVar("T")
@@ -54,29 +55,6 @@ def add_methods_of_singular_class_to_iterable_class(singular_cls: Type[T]) -> Ca
             instances of [singular_cls].
         """
 
-        def process_in_batch(
-            method: Callable, self: IterableKfinanceClass, *args: Any, **kwargs: Any
-        ) -> dict:
-            with self.kfinance_api_client.batch_request_header(batch_size=len(self)):
-                futures = []
-                for obj in self:
-                    # Acquire throttle before submitting the task
-                    throttle.acquire()
-                    future = self.kfinance_api_client.thread_pool.submit(
-                        method, obj, *args, **kwargs
-                    )
-                    # On success or failure, release the throttle.
-                    # This releases the throttle before the
-                    # `resolve_future_with_error_handling` call.
-                    future.add_done_callback(lambda f: throttle.release())
-                    futures.append(future)
-
-                results = {}
-                for obj, future in zip(self, futures):
-                    results[obj] = resolve_future_with_error_handling(future)
-
-            return results
-
         for method_name in dir(singular_cls):
             method = getattr(singular_cls, method_name)
             if method_name.startswith("__") or method_name.startswith("set_"):
@@ -88,7 +66,13 @@ def add_methods_of_singular_class_to_iterable_class(singular_cls: Type[T]) -> Ca
                     def method_wrapper(
                         self: IterableKfinanceClass, *args: Any, **kwargs: Any
                     ) -> dict:
-                        return process_in_batch(method, self, *args, **kwargs)
+                        return process_tasks_in_thread_pool_executor(
+                            api_client=self.kfinance_api_client,
+                            tasks=[
+                                Task(func=method, args=(obj, *args), kwargs=kwargs, result_key=obj)
+                                for obj in self
+                            ],
+                        )
 
                     return method_wrapper
 
@@ -102,7 +86,12 @@ def add_methods_of_singular_class_to_iterable_class(singular_cls: Type[T]) -> Ca
                     @functools.wraps(method.fget)
                     def prop_wrapper(self: IterableKfinanceClass) -> Any:
                         assert method.fget is not None
-                        return process_in_batch(method.fget, self)
+                        return process_tasks_in_thread_pool_executor(
+                            api_client=self.kfinance_api_client,
+                            tasks=[
+                                Task(func=method.fget, args=(obj,), result_key=obj) for obj in self
+                            ],
+                        )
 
                     return prop_wrapper
 
@@ -113,6 +102,53 @@ def add_methods_of_singular_class_to_iterable_class(singular_cls: Type[T]) -> Ca
     return decorator
 
 
+@dataclass(kw_only=True)
+class Task:
+    """A task for batch processing.
+
+    - args and kwargs are intended to be passed into the func as func(*args, **kwargs)
+    - results from batch processing are returned as dicts. The result_key is usually
+        something that either is an id (e.g. company_id) or has an id (e.g. Company
+        or CompanyIdentifier), used to map from that key to the corresponding result.
+    - The future is used to store the batch processing future. It should not be modified
+        directly outside of process_tasks_in_thread_pool_executor.
+    """
+
+    func: Callable
+    args: Any = field(default_factory=tuple)
+    kwargs: Any = field(default_factory=dict)
+    result_key: Hashable
+    future: Future | None = field(init=False, default=None)
+
+
+def process_tasks_in_thread_pool_executor(api_client: KFinanceApiClient, tasks: list[Task]) -> dict:
+    """Execute a list of tasks in the api client's thread pool executor and return the results.
+
+    Returns a dict mapping from each task's key to the corresponding result.
+    """
+
+    # Update access if necessary before submitting batch job.
+    # If the batch job starts without a valid token, each thread may try to refresh it.
+    assert api_client.access_token
+    with api_client.batch_request_header(batch_size=len(tasks)):
+        for task in tasks:
+            # Acquire throttle before submitting the task
+            throttle.acquire()
+            future = api_client.thread_pool.submit(task.func, *task.args, **task.kwargs)
+            # On success or failure, release the throttle.
+            # This releases the throttle before the
+            # `resolve_future_with_error_handling` call.
+            future.add_done_callback(lambda f: throttle.release())
+            task.future = future
+
+        results = {}
+        for task in tasks:
+            assert task.future
+            results[task.result_key] = resolve_future_with_error_handling(task.future)
+
+    return results
+
+
 def resolve_future_with_error_handling(future: Future) -> Any:
     """Return the result of a future with error handling for non-200 status codes.
 

kfinance/{fetch.py → client/fetch.py}

@@ -7,19 +7,21 @@ from typing import Callable, Generator, Optional
 from uuid import uuid4
 
 import jwt
-from pydantic import ValidationError
 import requests
 
-from kfinance.models.business_relationship_models import BusinessRelationshipType
-from kfinance.models.capitalization_models import Capitalizations
-from kfinance.models.competitor_models import CompetitorSource
-from kfinance.models.date_and_period_models import Periodicity, PeriodType
-from kfinance.models.id_models import IdentificationTriple
-from kfinance.models.industry_models import IndustryClassification
-from kfinance.models.permission_models import Permission
-from kfinance.models.price_models import PriceHistory
-from kfinance.models.segment_models import SegmentType
-from kfinance.pydantic_models import RelationshipResponse, RelationshipResponseNoName
+from kfinance.client.industry_models import IndustryClassification
+from kfinance.client.models.date_and_period_models import Periodicity, PeriodType
+from kfinance.client.permission_models import Permission
+from kfinance.domains.business_relationships.business_relationship_models import (
+    BusinessRelationshipType,
+    RelationshipResponse,
+)
+from kfinance.domains.capitalizations.capitalization_models import Capitalizations
+from kfinance.domains.companies.company_models import IdentificationTriple
+from kfinance.domains.competitors.competitor_models import CompetitorResponse, CompetitorSource
+from kfinance.domains.earnings.earning_models import EarningsCallResp
+from kfinance.domains.prices.price_models import PriceHistory
+from kfinance.domains.segments.segment_models import SegmentType
 
 
 # version.py gets autogenerated by setuptools-scm and is not available
@@ -528,30 +530,20 @@ class KFinanceApiClient:
 
     def fetch_companies_from_business_relationship(
         self, company_id: int, relationship_type: BusinessRelationshipType
-    ) -> RelationshipResponse | RelationshipResponseNoName:
+    ) -> RelationshipResponse:
         """Fetches a dictionary of current and previous company IDs and names associated with a given company ID based on the specified relationship type.
 
         Example: fetch_companies_from_business_relationship(company_id=1234, relationship_type="distributor") returns a dictionary of company 1234's current and previous distributors.
 
-        As of 2024-05-28, we are changing the response on the backend from
-        RelationshipResponseNoName to RelationshipResponse. This function can handle both response
-        types.
-
         :param company_id: The ID of the company for which associated companies are being fetched.
         :type company_id: int
         :param relationship_type: The type of relationship to filter by. Valid relationship types are defined in the BusinessRelationshipType class.
         :type relationship_type: BusinessRelationshipType
-        :return: A dictionary containing lists of current and previous company IDs that have the specified relationship with the given company_id.
-        :rtype: RelationshipResponse | RelationshipResponseNoName
+        :return: A dictionary containing lists of current and previous company IDs and names that have the specified relationship with the given company_id.
+        :rtype: RelationshipResponse
         """
         url = f"{self.url_base}relationship/{company_id}/{relationship_type}"
-        result = self.fetch(url)
-        # Try to parse as the newer RelationshipResponse and fall back to
-        # RelationshipResponseNoName if that fails.
-        try:
-            return RelationshipResponse.model_validate(result)
-        except ValidationError:
-            return RelationshipResponseNoName.model_validate(result)
+        return RelationshipResponse.model_validate(self.fetch(url))
 
     def fetch_ticker_from_industry_code(
         self,
@@ -589,22 +581,24 @@ class KFinanceApiClient:
         url = f"{self.url_base}company_groups/industry/{industry_classification}/{industry_code}"
         return self.fetch(url)
 
-    def fetch_earnings(self, company_id: int) -> dict:
+    def fetch_earnings(self, company_id: int) -> EarningsCallResp:
         """Get the earnings for a company."""
         url = f"{self.url_base}earnings/{company_id}"
-        return self.fetch(url)
+        return EarningsCallResp.model_validate(self.fetch(url))
 
     def fetch_transcript(self, key_dev_id: int) -> dict:
         """Get the transcript for an earnings item."""
         url = f"{self.url_base}transcript/{key_dev_id}"
         return self.fetch(url)
 
-    def fetch_competitors(self, company_id: int, competitor_source: CompetitorSource) -> dict:
+    def fetch_competitors(
+        self, company_id: int, competitor_source: CompetitorSource
+    ) -> CompetitorResponse:
         """Get the competitors for a company."""
         url = f"{self.url_base}competitors/{company_id}"
         if competitor_source is not CompetitorSource.all:
             url = url + f"/{competitor_source}"
-        return self.fetch(url)
+        return CompetitorResponse.model_validate(self.fetch(url))
 
     def fetch_mergers_for_company(
         self,

kfinance/{kfinance.py → client/kfinance.py}

@@ -2,7 +2,6 @@ from __future__ import annotations
 
 from collections.abc import Sequence
 from concurrent.futures import ThreadPoolExecutor
-from copy import deepcopy
 from datetime import date, datetime, timezone
 from io import BytesIO
 import logging
@@ -18,29 +17,32 @@ from langchain_google_genai._function_utils import convert_to_genai_function_dec
 import pandas as pd
 from PIL.Image import Image, open as image_open
 
-from kfinance.batch_request_handling import add_methods_of_singular_class_to_iterable_class
-from kfinance.fetch import (
+from kfinance.client.batch_request_handling import add_methods_of_singular_class_to_iterable_class
+from kfinance.client.fetch import (
     DEFAULT_API_HOST,
     DEFAULT_API_VERSION,
     DEFAULT_OKTA_AUTH_SERVER,
     DEFAULT_OKTA_HOST,
     KFinanceApiClient,
 )
-from kfinance.meta_classes import (
+from kfinance.client.industry_models import IndustryClassification
+from kfinance.client.meta_classes import (
     CompanyFunctionsMetaClass,
     DelegatedCompanyFunctionsMetaClass,
 )
-from kfinance.models.date_and_period_models import LatestPeriods, Periodicity, YearAndQuarter
-from kfinance.models.id_models import IdentificationTriple
-from kfinance.models.industry_models import IndustryClassification
-from kfinance.models.price_models import HistoryMetadata, PriceHistory
-from kfinance.prompt import PROMPT
-from kfinance.pydantic_models import TranscriptComponent
-from kfinance.server_thread import ServerThread
+from kfinance.client.models.date_and_period_models import (
+    LatestPeriods,
+    Periodicity,
+    YearAndQuarter,
+)
+from kfinance.client.server_thread import ServerThread
+from kfinance.domains.companies.company_models import IdentificationTriple
+from kfinance.domains.earnings.earning_models import EarningsCall, TranscriptComponent
+from kfinance.domains.prices.price_models import HistoryMetadata, PriceHistory
 
 
 if TYPE_CHECKING:
-    from kfinance.tool_calling.shared_models import KfinanceTool
+    from kfinance.integrations.tool_calling.tool_calling_models import KfinanceTool
 
 logger = logging.getLogger(__name__)
 
@@ -266,6 +268,19 @@ class Earnings:
         self.key_dev_id = key_dev_id
         self._transcript: Transcript | None = None
 
+    @classmethod
+    def from_earnings_call(
+        cls, earnings_call: EarningsCall, kfinance_api_client: KFinanceApiClient
+    ) -> "Earnings":
+        """Generate an Earnings object from an EarningsCall pydantic model."""
+
+        return Earnings(
+            name=earnings_call.name,
+            datetime=earnings_call.datetime,
+            key_dev_id=earnings_call.key_dev_id,
+            kfinance_api_client=kfinance_api_client,
+        )
+
     def __str__(self) -> str:
         """String representation for the earnings object"""
         return f"{type(self).__module__}.{type(self).__qualname__} of {self.key_dev_id}"
@@ -513,24 +528,13 @@ class Company(CompanyFunctionsMetaClass):
             return self._all_earnings
 
         earnings_data = self.kfinance_api_client.fetch_earnings(self.company_id)
-        self._all_earnings = []
-
-        for earnings in earnings_data["earnings"]:
-            if "keydevid" in earnings:
-                earnings["key_dev_id"] = deepcopy(earnings["keydevid"])
-                del earnings["keydevid"]
-            earnings_datetime = datetime.fromisoformat(
-                earnings["datetime"].replace("Z", "+00:00")
-            ).replace(tzinfo=timezone.utc)
-
-            self._all_earnings.append(
-                Earnings(
-                    kfinance_api_client=self.kfinance_api_client,
-                    name=earnings["name"],
-                    datetime=earnings_datetime,
-                    key_dev_id=earnings["key_dev_id"],
-                )
+
+        self._all_earnings = [
+            Earnings.from_earnings_call(
+                earnings_call=earnings_call, kfinance_api_client=self.kfinance_api_client
             )
+            for earnings_call in earnings_data.earnings_calls
+        ]
 
         return self._all_earnings
 
@@ -1398,6 +1402,7 @@ class Securities(set):
         :param security_ids: An iterable of S&P CIQ Security ids
         :type security_ids: Iterable[int]
         """
+        self.kfinance_api_client = kfinance_api_client
         super().__init__(Security(kfinance_api_client, security_id) for security_id in security_ids)
 
 
@@ -1541,8 +1546,6 @@ class Client:
     :type openai_tool_descriptions: list[dict]
     """
 
-    prompt = PROMPT
-
     def __init__(
         self,
         refresh_token: Optional[str] = None,
@@ -1622,9 +1625,10 @@ class Client:
     @property
     def langchain_tools(self) -> list["KfinanceTool"]:
         """Return a list of all Kfinance tools for tool calling."""
-        if self._tools is None:
-            from kfinance.tool_calling import ALL_TOOLS
 
+        from kfinance.integrations.tool_calling.all_tools import ALL_TOOLS
+
+        if self._tools is None:
             self._tools = []
             # Add tool to _tools if the user has permissions to use it.
             for tool_cls in ALL_TOOLS:

kfinance/{meta_classes.py → client/meta_classes.py}

@@ -7,14 +7,15 @@ from cachetools import LRUCache, cached
 import numpy as np
 import pandas as pd
 
-from .fetch import KFinanceApiClient
-from .models.business_relationship_models import BusinessRelationshipType
-from .models.capitalization_models import Capitalization
-from .models.competitor_models import CompetitorSource
-from .models.date_and_period_models import PeriodType
-from .models.line_item_models import LINE_ITEMS
-from .models.segment_models import SegmentType
-from .pydantic_models import RelationshipResponse
+from kfinance.client.fetch import KFinanceApiClient
+from kfinance.client.models.date_and_period_models import PeriodType
+from kfinance.domains.business_relationships.business_relationship_models import (
+    BusinessRelationshipType,
+)
+from kfinance.domains.capitalizations.capitalization_models import Capitalization
+from kfinance.domains.competitors.competitor_models import CompetitorSource
+from kfinance.domains.line_items.line_item_models import LINE_ITEMS
+from kfinance.domains.segments.segment_models import SegmentType
 
 
 if TYPE_CHECKING:
@@ -234,28 +235,16 @@ class CompanyFunctionsMetaClass:
             company_id=self.company_id,
             relationship_type=relationship_type,
         )
-        if isinstance(relationship_resp, RelationshipResponse):
-            return BusinessRelationships(
-                current=Companies(
-                    kfinance_api_client=self.kfinance_api_client,
-                    company_ids=[c.company_id for c in relationship_resp.current],
-                ),
-                previous=Companies(
-                    kfinance_api_client=self.kfinance_api_client,
-                    company_ids=[c.company_id for c in relationship_resp.previous],
-                ),
-            )
-        else:
-            return BusinessRelationships(
-                current=Companies(
-                    kfinance_api_client=self.kfinance_api_client,
-                    company_ids=relationship_resp.current,
-                ),
-                previous=Companies(
-                    kfinance_api_client=self.kfinance_api_client,
-                    company_ids=relationship_resp.previous,
-                ),
-            )
+        return BusinessRelationships(
+            current=Companies(
+                kfinance_api_client=self.kfinance_api_client,
+                company_ids=[c.company_id for c in relationship_resp.current],
+            ),
+            previous=Companies(
+                kfinance_api_client=self.kfinance_api_client,
+                company_ids=[c.company_id for c in relationship_resp.previous],
+            ),
+        )
 
     def market_cap(
         self,
@@ -329,7 +318,9 @@ class CompanyFunctionsMetaClass:
         capitalizations = self.kfinance_api_client.fetch_market_caps_tevs_and_shares_outstanding(
             company_id=self.company_id, start_date=start_date, end_date=end_date
         )
-        return capitalizations.jsonify_single_attribute(capitalization_to_extract)
+        return capitalizations.model_dump_json_single_metric(
+            capitalization_metric=capitalization_to_extract
+        )
 
     def _segments(
         self,
@@ -437,16 +428,16 @@ class CompanyFunctionsMetaClass:
 
         competitors_data = self.kfinance_api_client.fetch_competitors(
             company_id=self.company_id, competitor_source=competitor_source
-        )["competitors"]
+        )
         return Companies(
             kfinance_api_client=self.kfinance_api_client,
             companies=[
                 Company(
                     kfinance_api_client=self.kfinance_api_client,
-                    company_id=company["company_id"],
-                    company_name=company["company_name"],
+                    company_id=company.company_id,
+                    company_name=company.company_name,
                 )
-                for company in competitors_data
+                for company in competitors_data.competitors
             ],
         )
 

kfinance/{decimal_with_unit.py → client/models/decimal_with_unit.py}

@@ -5,7 +5,7 @@ from typing import Any
 from pydantic import BaseModel, Field, model_validator
 from typing_extensions import Self
 
-from kfinance.models.currency_models import ISO_CODE_TO_CURRENCY
+from kfinance.client.models.currency_models import ISO_CODE_TO_CURRENCY
 
 
 class DecimalWithUnit(BaseModel):

kfinance/{tests → client/models/tests}/test_decimal_with_unit.py

@@ -3,7 +3,7 @@ from typing import Any
 
 import pytest
 
-from kfinance.decimal_with_unit import DecimalWithUnit, Money, Shares
+from kfinance.client.models.decimal_with_unit import DecimalWithUnit, Money, Shares
 
 
 class TestDecimalWithUnit:

kfinance/{tests → client/tests}/test_batch_requests.py

@@ -9,16 +9,18 @@ import pytest
 import requests
 import requests_mock
 
-from kfinance.batch_request_handling import MAX_WORKERS_CAP
-from kfinance.decimal_with_unit import Money, Shares
-from kfinance.fetch import KFinanceApiClient
-from kfinance.kfinance import Companies, Company, Ticker, TradingItem, TradingItems
-from kfinance.models.price_models import PriceHistory, Prices
+from kfinance.client.batch_request_handling import MAX_WORKERS_CAP
+from kfinance.client.fetch import KFinanceApiClient
+from kfinance.client.kfinance import Companies, Company, Ticker, TradingItem, TradingItems
+from kfinance.client.models.decimal_with_unit import Money, Shares
+from kfinance.domains.prices.price_models import PriceHistory, Prices
 
 
 @pytest.fixture(autouse=True)
 def mock_method():
-    with patch("kfinance.fetch.KFinanceApiClient.access_token", return_value="fake_access_token"):
+    with patch(
+        "kfinance.client.fetch.KFinanceApiClient.access_token", return_value="fake_access_token"
+    ):
         yield