kensho-kfinance 2.0.0__tar.gz → 2.0.1__tar.gz

{kensho_kfinance-2.0.0 → kensho_kfinance-2.0.1}/.readthedocs.yaml

@@ -3,13 +3,15 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.10"
-    # You can also specify other tool versions:
-    # nodejs: "16"
-  # borrowed from here:
-  # https://docs.readthedocs.com/platform/stable/build-customization.html#avoid-having-a-dirty-git-index
   jobs:
     pre_install:
+      # borrowed from here:
+      # https://docs.readthedocs.com/platform/stable/build-customization.html#avoid-having-a-dirty-git-index
       - git update-index --assume-unchanged docs/conf.py
+    pre_build:
+      # build documentation for tool calling before generating docs.
+      - pip install langchain-core
+      - python docs/build_tool_calling_documentation.py
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

{kensho_kfinance-2.0.0/kensho_kfinance.egg-info → kensho_kfinance-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.0.0
+Version: 2.0.1
 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-2.0.0 → kensho_kfinance-2.0.1}/docs/build_tool_calling_documentation.py

@@ -1,5 +1,5 @@
-import inspect
 from enum import Enum
+import inspect
 from pathlib import Path
 
 from langchain_core.utils.function_calling import convert_to_openai_tool
@@ -48,11 +48,7 @@ def add_function_to_tools_file(tool: KfinanceTool) -> None:
     """
 
     # The signature built with the inspect module does not include necessary imports.
-    imports = [
-        "import kfinance",
-        "import datetime",
-        "from typing import Optional"
-    ]
+    imports = ["import kfinance", "import datetime", "from typing import Optional"]
     signature_str = build_signature_str(tool)
 
     # Use inspect to retrieve the return type and add it to the imports if it's not a builtin.
@@ -66,10 +62,6 @@ def add_function_to_tools_file(tool: KfinanceTool) -> None:
     for field_name, field_metadata in tool.args_schema.model_fields.items():
         # We use the openai definition to extract the field description. This means that, just like
         # pydantic/langchain, we use the docstring of an enum as the description for an enum field.
-        try:
-            openai_params[field_name]['description']
-        except:
-            assert False, tool.name
         args += f"\n    :param {field_name}: {openai_params[field_name]['description']}"
         args += f"\n    :type {field_name}: {display_as_type(field_metadata.annotation)}"
 
@@ -84,7 +76,8 @@ def add_function_to_tools_file(tool: KfinanceTool) -> None:
     with open(inspect.getfile(tool.__class__), mode="a") as f:
         f.write(func_str)
 
-def build_signature_str(tool) -> str:
+
+def build_signature_str(tool: KfinanceTool) -> str:
     """Return the signature string of the tool
 
     Return value example:
@@ -104,7 +97,6 @@ def build_signature_str(tool) -> str:
     return f"def {tool.name}{signature}:"
 
 
-
 def add_module_to_tool_calling_rst(tool: KfinanceTool) -> None:
     """Add a module for each tool to tool_calling.rst.
 
@@ -121,3 +113,6 @@ def add_module_to_tool_calling_rst(tool: KfinanceTool) -> None:
 
     with open(Path(Path(__file__).resolve().parent, "tool_calling.rst"), mode="a") as f:
         f.write(module_str)
+
+if __name__ == "__main__":
+    add_tool_calling_docs_for_all_tools()

{kensho_kfinance-2.0.0 → kensho_kfinance-2.0.1}/docs/conf.py

@@ -7,15 +7,10 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 from importlib.metadata import version as get_version
 
-from docs.build_tool_calling_documentation import add_tool_calling_docs_for_all_tools
-
-
 project = "kensho-kfinance"
 copyright = "2025, Kensho Technologies"
 author = "Kensho Technologies"
 
-# Add documentation for tool calling.
-add_tool_calling_docs_for_all_tools()
 
 # borrowed from here:
 # https://setuptools-scm.readthedocs.io/en/latest/usage/#usage-from-sphinx
@@ -59,7 +54,6 @@ templates_path = ["templates"]
 source_suffix = [".rst", ".md"]
 
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

{kensho_kfinance-2.0.0 → kensho_kfinance-2.0.1/kensho_kfinance.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 2.0.0
+Version: 2.0.1
 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-2.0.0 → kensho_kfinance-2.0.1}/kfinance/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v2.0.1
+- Fix readthedocs integration for llm tools.
+
 ## v2.0.0
 - Refactor llm tools to use langchain `BaseTool`.
 

{kensho_kfinance-2.0.0 → kensho_kfinance-2.0.1}/kfinance/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.0.0'
-__version_tuple__ = version_tuple = (2, 0, 0)
+__version__ = version = '2.0.1'
+__version_tuple__ = version_tuple = (2, 0, 1)