kensho-kfinance 2.6.1__tar.gz → 2.6.2__tar.gz

{kensho_kfinance-2.6.1/kensho_kfinance.egg-info → kensho_kfinance-2.6.2}/PKG-INFO

@@ -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 → kensho_kfinance-2.6.2}/README.md

@@ -21,11 +21,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.
 
@@ -42,15 +42,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 → kensho_kfinance-2.6.2/kensho_kfinance.egg-info}/PKG-INFO

@@ -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 → kensho_kfinance-2.6.2}/kensho_kfinance.egg-info/requires.txt

@@ -13,7 +13,7 @@ strenum>=0.4.15
 tabulate>=0.9.0
 types-requests<3,>=2.22.0
 requests<3,>=2.22.0
-urllib3>=1.21.1
+urllib3>=2.5
 
 [dev]
 coverage<8,>=7.6.10

{kensho_kfinance-2.6.1 → kensho_kfinance-2.6.2}/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
 

{kensho_kfinance-2.6.1 → kensho_kfinance-2.6.2}/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

{kensho_kfinance-2.6.1 → kensho_kfinance-2.6.2}/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,
         }

{kensho_kfinance-2.6.1 → kensho_kfinance-2.6.2}/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)

{kensho_kfinance-2.6.1 → kensho_kfinance-2.6.2}/pyproject.toml

@@ -33,7 +33,7 @@ dependencies = [
     "tabulate>=0.9.0",  # required for turning dataframes into markdown
     "types-requests>=2.22.0,<3",
     "requests>=2.22.0,<3",
-    "urllib3>=1.21.1",
+    "urllib3>=2.5",
 ]
 
 [project.optional-dependencies]