kensho-kfinance 2.6.1__py3-none-any.whl → 2.6.2__py3-none-any.whl

{kensho_kfinance-2.6.1.dist-info → kensho_kfinance-2.6.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.6.1
+Version: 2.6.2
 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
@@ -27,7 +27,7 @@ Requires-Dist: strenum>=0.4.15
 Requires-Dist: tabulate>=0.9.0
 Requires-Dist: types-requests<3,>=2.22.0
 Requires-Dist: requests<3,>=2.22.0
-Requires-Dist: urllib3>=1.21.1
+Requires-Dist: urllib3>=2.5
 Provides-Extra: dev
 Requires-Dist: coverage<8,>=7.6.10; extra == "dev"
 Requires-Dist: ipykernel<7,>=6.29; extra == "dev"
@@ -67,11 +67,11 @@ Once access is obtained, get started using the [Authentication Guide](https://do
 To get started, we provide some notebooks:
 
 - The [LLM-ready API Basic Usage](example_notebooks%2Fbasic_usage.ipynb) notebook demonstrates how
-fetch data with the kFinance client.
+  fetch data with the kFinance client.
 - The [tool_calling notebooks](example_notebooks%2Ftool_calling) show how the kFinance library can
-be used for tool calling. We provide notebooks for OpenAI (GPT), Anthropic (Claude), and Google
+  be used for tool calling. We provide notebooks for OpenAI (GPT), Anthropic (Claude), and Google
   (Gemini). Each of these integrations comes in a langchain version, which uses langchain as a
-wrapper to simplify the integration, and as a lower level non-langchain version.
+  wrapper to simplify the integration, and as a lower level non-langchain version.
 
 We also provide an [interactive notebook](example_notebooks/basic_usage.ipynb) that demonstrates some usage examples.
 
@@ -88,15 +88,48 @@ The server's full signature is as follows:
 `kfinance.mcp [--stdio,-s]/[--sse, ] --refresh-token <refresh-token> --client-id <client-id> --private-key <private-key>`
 
 Authentication Methods (in order of precedence):
+
 1. Refresh Token: Uses an existing refresh token for authentication. The `--refresh-token <refresh-token>` argument must be provided.
 2. Key Pair: Uses client ID and private key for authentication. Both the `--client-id <client-id>` and `--private-key <private-key>` arguments must be provided.
 3. Browser: Falls back to browser-based authentication flow. This occurs if no auth arguments are provided.
 
 Transport Layers:
+
 - stdio can be set by passing either `--stdio` or `-s`
 - sse can be set by passing `--sse` or no other transport related flag
 
+# Development
+
+## Working with Local Package Version
+
+If you need to develop using a local version of the kFinance package in another project that uses [poetry](https://python-poetry.org/) for package and dependency management, follow these steps:
+
+1. In your dependent project's `pyproject.toml`, replace the kFinance package version specification:
+
+   ```toml
+   # Replace this:
+   # kensho-kfinance = "~2.0.1"
+   # With this:
+   kensho-kfinance = { path = "/absolute/path/to/kfinance", develop = true }
+   ```
+
+   The `develop = true` flag ensures that the package always matches your local version without requiring reinstallation after changes.
+
+2. Update your project's dependencies:
+
+   ```bash
+   poetry update    # Update poetry.lock with new changes
+   poetry install   # Install dependencies with updated configuration
+   ```
+
+   If you encounter the error "your pyproject.toml file has significantly changed", run:
+
+   ```bash
+   poetry lock     # Sync the changes to poetry.lock
+   ```
+
 # Versioning
+
 The kFinance uses semantic versioning (major, minor, patch).
 To bump the version, add a new entry in [CHANGELOG.md](kfinance%2FCHANGELOG.md).
 This will generate a new version of the library as part of the release process.

{kensho_kfinance-2.6.1.dist-info → kensho_kfinance-2.6.2.dist-info}/RECORD

@@ -1,18 +1,18 @@
-kensho_kfinance-2.6.1.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
-kensho_kfinance-2.6.1.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
-kfinance/CHANGELOG.md,sha256=U74yQTIC0g8uDx0qjN-92xtYcHn0gEBu_bz9XvmgT7c,1817
+kensho_kfinance-2.6.2.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
+kensho_kfinance-2.6.2.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
+kfinance/CHANGELOG.md,sha256=ndCVbkomHlJ7kB7FoNB3N17A97hrPPtu02dxh-JBdJA,1927
 kfinance/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/batch_request_handling.py,sha256=G9rhpgQaCdb5C1dsfuJip8383iszibcOJ5k8gxld-tQ,5001
 kfinance/constants.py,sha256=jaHsTXEmGKLp55x1_ob_MA-GVn_hua5B6RZCbujKWz0,49401
 kfinance/fetch.py,sha256=QyQjL2t9Z_tT1DD_Xzal59URH7QtnrpLQywcHSFtoWA,26691
-kfinance/kfinance.py,sha256=tsrmprBmG8zsIJrvLv-j-c7xXtU64EWbIjKw4cQBaGw,72456
+kfinance/kfinance.py,sha256=WNw6hR7eIKVFM5iBtGrArJcOowange_ed5_PAc0aLzE,72768
 kfinance/mcp.py,sha256=MbktclVfBOEwfe-eR7kPaTXopMJmn_8RMlf4Jx5CXKU,3689
 kfinance/meta_classes.py,sha256=bUkksl5a9NkQQWmSM2XIWP3jsmmP4ZAfvSxPW5tRZg4,21492
 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=ZCGpbBiHct-cyiHhdogfnoocBa55-WdHLBG45JCVyVk,511
+kfinance/version.py,sha256=0Bv8KyeMcw-iHj2UIKRw0oUzwjzKa7KzZIuWroBAK1A,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
@@ -38,7 +38,7 @@ kfinance/tool_calling/get_info_from_identifier.py,sha256=PRhSYpYs_iUcIVFGYCMN_7Q
 kfinance/tool_calling/get_isin_from_ticker.py,sha256=2fJBcA-rNGbVOQmQ7qJEYxqejQwJ6nyWOBSFlzxG7dY,638
 kfinance/tool_calling/get_latest.py,sha256=btGeVBmvX5QJutzrKfE6spatGGejDuHxtq53NoAaGNk,786
 kfinance/tool_calling/get_latest_earnings.py,sha256=pQdExGdztGY3pHcak0bd6ULNf_ROPc91bJ7zAVSKQkk,1117
-kfinance/tool_calling/get_merger_info_from_transaction_id.py,sha256=PodFtnY1_sRXcp51mBobQTqj__GMRbbMxgoRIhPBArA,2938
+kfinance/tool_calling/get_merger_info_from_transaction_id.py,sha256=8aMktxIs89czDRCn4o7LcUmoTO8ueUDI40nXHo6rNZY,3142
 kfinance/tool_calling/get_mergers_from_identifier.py,sha256=9tCaSrJsK3-i0ZDNKAJRhE-nRdJvQxTbrZbvVY0YmQw,1702
 kfinance/tool_calling/get_n_quarters_ago.py,sha256=A0ilwPKUqU0YYQSz3gNsVF0Jy4YttXrSaDhYj7y8GHA,713
 kfinance/tool_calling/get_next_earnings.py,sha256=knzQw-m-hscCvTuDUXG9v_dObKJBGn5BbDZWGKHKQcw,1097
@@ -48,7 +48,7 @@ kfinance/tool_calling/get_transcript.py,sha256=eB-IsRwD-mllsMOYRZbH35caQ1Y3teKft
 kfinance/tool_calling/prompts.py,sha256=Yw1DJIMh90cjL-8q6_RMRiSjCtFDXvJAy7QiV5_uAU8,911
 kfinance/tool_calling/resolve_identifier.py,sha256=npslr6bBCu0qEDV1-8d24F5OC3nQ1KBMphuMbHVC1AU,626
 kfinance/tool_calling/shared_models.py,sha256=loNoVFVyQnnpHLUIjkR6P9flGNbzp6kkGpL5hT37Sdg,2666
-kensho_kfinance-2.6.1.dist-info/METADATA,sha256=OLtcQoyXfVs3KjB1RSZu4kNYktKoKqGV8qLJBfZKTiA,5191
-kensho_kfinance-2.6.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kensho_kfinance-2.6.1.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
-kensho_kfinance-2.6.1.dist-info/RECORD,,
+kensho_kfinance-2.6.2.dist-info/METADATA,sha256=gmrV13LppEUpW6KMJKZftWQz1UlN165RC-G5Uwpxts8,6197
+kensho_kfinance-2.6.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kensho_kfinance-2.6.2.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
+kensho_kfinance-2.6.2.dist-info/RECORD,,

kfinance/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+# v2.6.3
+- Bump urllib3 to 2.5 to  address CVEs
+
+## v2.6.2
+ - Safely check for incomplete merger information
+
 ## v2.6.1
  - Remove get_earnings_call_datetimes_from_identifier tool
 

kfinance/kfinance.py

@@ -1279,11 +1279,17 @@ class MergerOrAcquisition:
         """Property for the combined information in the merger."""
         if not self._merger_info:
             self._merger_info = self.kfinance_api_client.fetch_merger_info(self.transaction_id)
-            timeline = pd.DataFrame(self.merger_info["timeline"])
-            timeline["date"] = pd.to_datetime(timeline["date"])
-            self._merger_info["timeline"] = timeline
-            details = pd.DataFrame(self.merger_info["consideration"]["details"])
-            self._merger_info["consideration"]["details"] = details
+            if "timeline" in self._merger_info and self._merger_info["timeline"]:
+                timeline = pd.DataFrame(self._merger_info["timeline"])
+                timeline["date"] = pd.to_datetime(timeline["date"])
+                self._merger_info["timeline"] = timeline
+            if (
+                "consideration" in self._merger_info
+                and self._merger_info["consideration"]
+                and "details" in self._merger_info["consideration"]
+            ):
+                details = pd.DataFrame(self._merger_info["consideration"]["details"])
+                self._merger_info["consideration"]["details"] = details
         return self._merger_info
 
     @property

kfinance/tool_calling/get_merger_info_from_transaction_id.py

@@ -31,7 +31,9 @@ class GetMergerInfoFromTransactionId(KfinanceTool):
             "timeline": [
                 {"status": timeline["status"], "date": timeline["date"].strftime("%Y-%m-%d")}
                 for timeline in merger_timeline.to_dict(orient="records")
-            ],
+            ]
+            if merger_timeline is not None
+            else None,
             "participants": {
                 "target": {
                     "company_id": merger_participants["target"].company_id,
@@ -45,7 +47,9 @@ class GetMergerInfoFromTransactionId(KfinanceTool):
                     {"company_id": seller.company_id, "company_name": seller.name}
                     for seller in merger_participants["sellers"]
                 ],
-            },
+            }
+            if merger_participants is not None
+            else None,
             "consideration": {
                 "currency_name": merger_consideration["currency_name"],
                 "current_calculated_gross_total_transaction_value": merger_consideration[
@@ -58,5 +62,7 @@ class GetMergerInfoFromTransactionId(KfinanceTool):
                     "current_calculated_implied_enterprise_value"
                 ],
                 "details": merger_consideration["details"].to_dict(orient="records"),
-            },
+            }
+            if merger_consideration is not None
+            else None,
         }

kfinance/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.6.1'
-__version_tuple__ = version_tuple = (2, 6, 1)
+__version__ = version = '2.6.2'
+__version_tuple__ = version_tuple = (2, 6, 2)