kensho-kfinance 2.7.0__tar.gz → 2.9.0__tar.gz

{kensho_kfinance-2.7.0/kensho_kfinance.egg-info → kensho_kfinance-2.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.7.0
+Version: 2.9.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
@@ -14,7 +14,7 @@ License-File: LICENSE
 License-File: AUTHORS.md
 Requires-Dist: cachetools<6,>=5.5
 Requires-Dist: click<=9,>=8.2.1
-Requires-Dist: fastmcp<3,>=2
+Requires-Dist: fastmcp<2.10,>=2.9
 Requires-Dist: langchain-core>=0.3.15
 Requires-Dist: langchain-google-genai<3,>=2.1.5
 Requires-Dist: numpy>=1.22.4

{kensho_kfinance-2.7.0 → kensho_kfinance-2.9.0}/example_notebooks/basic_usage.ipynb

@@ -98,7 +98,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from kfinance.constants import PeriodType\n",
+    "from kfinance.models.date_and_period_models import PeriodType\n",
     "\n",
     "# You can create a Ticker object with client.ticker.\n",
     "# A Ticker has access to a wide variety of attributes, including prices, \n",
@@ -220,7 +220,7 @@
    "execution_count": null,
    "outputs": [],
    "source": [
-    "from kfinance.constants import Periodicity\n",
+    "from kfinance.models.date_and_period_models import Periodicity\n",
     "\n",
     "# To fetch recent spgi prices, you can use the `history` function.\n",
     "# Without any further configuration `history()` will return adjusted\n",

{kensho_kfinance-2.7.0 → kensho_kfinance-2.9.0/kensho_kfinance.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.7.0
+Version: 2.9.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
@@ -14,7 +14,7 @@ License-File: LICENSE
 License-File: AUTHORS.md
 Requires-Dist: cachetools<6,>=5.5
 Requires-Dist: click<=9,>=8.2.1
-Requires-Dist: fastmcp<3,>=2
+Requires-Dist: fastmcp<2.10,>=2.9
 Requires-Dist: langchain-core>=0.3.15
 Requires-Dist: langchain-google-genai<3,>=2.1.5
 Requires-Dist: numpy>=1.22.4

{kensho_kfinance-2.7.0 → kensho_kfinance-2.9.0}/kensho_kfinance.egg-info/SOURCES.txt

@@ -36,7 +36,7 @@ kensho_kfinance.egg-info/top_level.txt
 kfinance/CHANGELOG.md
 kfinance/__init__.py
 kfinance/batch_request_handling.py
-kfinance/constants.py
+kfinance/decimal_with_unit.py
 kfinance/fetch.py
 kfinance/kfinance.py
 kfinance/mcp.py
@@ -46,16 +46,32 @@ kfinance/py.typed
 kfinance/pydantic_models.py
 kfinance/server_thread.py
 kfinance/version.py
+kfinance/models/__init__.py
+kfinance/models/business_relationship_models.py
+kfinance/models/capitalization_models.py
+kfinance/models/competitor_models.py
+kfinance/models/currency_models.py
+kfinance/models/date_and_period_models.py
+kfinance/models/id_models.py
+kfinance/models/industry_models.py
+kfinance/models/line_item_models.py
+kfinance/models/permission_models.py
+kfinance/models/price_models.py
+kfinance/models/segment_models.py
+kfinance/models/statement_models.py
 kfinance/tests/__init__.py
 kfinance/tests/conftest.py
-kfinance/tests/scratch.py
 kfinance/tests/test_batch_requests.py
 kfinance/tests/test_client.py
+kfinance/tests/test_decimal_with_unit.py
 kfinance/tests/test_example_notebook.py
 kfinance/tests/test_fetch.py
 kfinance/tests/test_group_objects.py
 kfinance/tests/test_objects.py
 kfinance/tests/test_tools.py
+kfinance/tests/test_models/__init__.py
+kfinance/tests/test_models/test_capitalization_models.py
+kfinance/tests/test_models/test_price_models.py
 kfinance/tool_calling/README.md
 kfinance/tool_calling/__init__.py
 kfinance/tool_calling/get_advisors_for_company_in_transaction_from_identifier.py

{kensho_kfinance-2.7.0 → kensho_kfinance-2.9.0}/kensho_kfinance.egg-info/requires.txt

@@ -1,6 +1,6 @@
 cachetools<6,>=5.5
 click<=9,>=8.2.1
-fastmcp<3,>=2
+fastmcp<2.10,>=2.9
 langchain-core>=0.3.15
 langchain-google-genai<3,>=2.1.5
 numpy>=1.22.4

{kensho_kfinance-2.7.0 → kensho_kfinance-2.9.0}/kfinance/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v2.9.0
+- Limit FastMCP version
+
+## v2.8.0
+- Add currency to get_capitalization and get_prices tools.
+
 ## v2.7.0
  - Expose a new list of LLM tools `grounding_tools` that return a list of all endpoint urls called
 

kensho_kfinance-2.9.0/kfinance/decimal_with_unit.py

@@ -0,0 +1,78 @@
+from copy import deepcopy
+from decimal import Decimal
+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
+
+
+class DecimalWithUnit(BaseModel):
+    """DecimalWithUnit (DWU) represents a decimal with a corresponding unit like $100 or 20 shares.
+
+    In addition to a value and unit, each DWU has a `conventional_decimals` attribute,
+    which indicates the number of decimals that should be represented.
+    For example, for USD, conventional_decimals is 2, which will display as "1.00".
+    For shares, conventional_decimals is 0, which will display as "1"
+
+    Usually, rather than initializing a DWU directly, you'll likely want to use an
+    existing subclass like `Money` or `Shares` or create a new one.
+    """
+
+    value: Decimal
+    unit: str
+    # exclude conventional_decimals from serialization
+    conventional_decimals: int = Field(exclude=True)
+
+    @model_validator(mode="after")
+    def quantize_value(self) -> Self:
+        """Quantize the value at the end of the deserialization.
+
+        The value gets adjusted so that it always has the expected number of decimals defined in
+        conventional_decimals.
+        For USD with conventional_decimals=2, it will show values like "1.00"
+        For Shares with conventional_decimals=0, it will show values like "1"
+        """
+        exponent = Decimal("10") ** Decimal(-self.conventional_decimals)
+        self.value = self.value.quantize(exp=exponent)
+        return self
+
+
+class Money(DecimalWithUnit):
+    @model_validator(mode="before")
+    @classmethod
+    def inject_conventional_decimals_into_data(cls, data: Any) -> Any:
+        """Inject conventional_decimals into data dict.
+
+        Each currency has an associated conventional_decimals defined in the
+        CURRENCIES list. This validator fetches that number and injects it into the
+        data dict.
+        """
+
+        if isinstance(data, dict) and "conventional_decimals" not in data:
+            data = deepcopy(data)
+            currency = ISO_CODE_TO_CURRENCY[data["unit"]]
+            data["conventional_decimals"] = currency.conventional_decimals
+
+        return data
+
+
+class Shares(DecimalWithUnit):
+    unit: str = "Shares"
+    conventional_decimals: int = Field(exclude=True, default=0)
+
+    @model_validator(mode="before")
+    @classmethod
+    def convert_numbers_to_dicts(cls, data: Any) -> Any:
+        """Convert numbers into dicts.
+
+        The shares class can be built from a single number because unit and
+        conventional_decimals are always the same. However, the parser expects a
+        dict instead of a number, so we have to convert any number ("10") into a
+        dict {"value": "10"}.
+        """
+
+        if isinstance(data, (str, int, float, Decimal)):
+            data = {"value": data}
+        return data

{kensho_kfinance-2.7.0 → kensho_kfinance-2.9.0}/kfinance/fetch.py

@@ -10,23 +10,22 @@ import jwt
 from pydantic import ValidationError
 import requests
 
-from .constants import (
-    BusinessRelationshipType,
-    CompetitorSource,
-    IdentificationTriple,
-    IndustryClassification,
-    Periodicity,
-    PeriodType,
-    Permission,
-    SegmentType,
-)
-from .pydantic_models import RelationshipResponse, RelationshipResponseNoName
+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
 
 
 # version.py gets autogenerated by setuptools-scm and is not available
 # during local development.
 try:
-    from .version import __version__ as kfinance_version
+    from kfinance.version import __version__ as kfinance_version
 except ImportError:
     kfinance_version = "dev"
 
@@ -300,7 +299,7 @@ class KFinanceApiClient:
         start_date: Optional[str] = None,
         end_date: Optional[str] = None,
         periodicity: Optional[Periodicity] = None,
-    ) -> dict:
+    ) -> PriceHistory:
         """Get the pricing history."""
         url = (
             f"{self.url_base}pricing/{trading_item_id}/"
@@ -309,7 +308,7 @@ class KFinanceApiClient:
             f"{periodicity if periodicity else 'none'}/"
             f"{'adjusted' if is_adjusted else 'unadjusted'}"
         )
-        return self.fetch(url)
+        return PriceHistory.model_validate(self.fetch(url))
 
     def fetch_history_metadata(self, trading_item_id: int) -> dict[str, str]:
         """Get the pricing history metadata."""
@@ -321,14 +320,14 @@ class KFinanceApiClient:
         company_id: int,
         start_date: Optional[str] = None,
         end_date: Optional[str] = None,
-    ) -> dict:
+    ) -> Capitalizations:
         """Get the market cap, TEV, and shares outstanding for a company."""
         url = (
             f"{self.url_base}market_cap/{company_id}/"
             f"{start_date if start_date is not None else 'none'}/"
             f"{end_date if end_date is not None else 'none'}"
         )
-        return self.fetch(url)
+        return Capitalizations.model_validate(self.fetch(url))
 
     def fetch_segments(
         self,