kensho-kfinance 1.1.0__tar.gz → 1.1.0a0__tar.gz

kensho_kfinance-1.1.0a0/.readthedocs.yaml

@@ -0,0 +1,21 @@
+version: 2
+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:
+      - git update-index --assume-unchanged docs/conf.py
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Dependencies required to build your docs
+python:
+  install:
+    - requirements: docs/requirements.txt

{kensho_kfinance-1.1.0 → kensho_kfinance-1.1.0a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 1.1.0
+Version: 1.1.0a0
 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-1.1.0a0/docs/conf.py

@@ -0,0 +1,66 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+from importlib.metadata import version as get_version
+
+project = 'kensho-kfinance'
+copyright = '2025, Kensho Technologies'
+author = 'Kensho Technologies'
+
+# borrowed from here:
+# https://setuptools-scm.readthedocs.io/en/latest/usage/#usage-from-sphinx
+release: str = get_version(project)
+# for example take major/minor
+version: str = ".".join(release.split('.')[:2])
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+# borrowed from internal Kensho Sphinx configuration
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.coverage",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    # 3rd party extensions
+    # m2r2 is to add support to .md files specifically to include README.md files.
+    # See this discussion: https://github.com/sphinx-doc/sphinx/issues/7000
+    "m2r2",
+    # A ReadTheDocs theme for Sphinx
+    "sphinx_rtd_theme",
+]
+
+napoleon_google_docstring = True
+napoleon_use_ivar = True
+
+autosummary_generate = True
+
+# Don't prepend module path prefixes to function definitions. Makes automodule docs less cluttered
+add_module_names = False
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["templates"]
+
+# The suffix of source filenames.
+source_suffix = [".rst", ".md"]
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+
+# https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html
+html_theme_options = {"body_min_width": 0, "body_max_width": "none"}
+
+# https://www.sphinx-doc.org/en/1.4.9/config.html#confval-html_sidebars
+html_sidebars = {"**": ["globaltoc.html", "relations.html", "searchbox.html"]}

kensho_kfinance-1.1.0a0/docs/index.rst

@@ -0,0 +1,18 @@
+Index
+#####################
+
+Documentation page for kensho-kfinance library.
+
+.. toctree::
+   :hidden:
+   :glob:
+   :maxdepth: 1
+
+   kfinance <kfinance>
+   llm_tools <llm_tools>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`

kensho_kfinance-1.1.0a0/docs/kfinance.rst

@@ -0,0 +1,7 @@
+kfinance
+========
+
+.. automodule:: kfinance.kfinance
+   :members:
+   :undoc-members:
+   :inherited-members:

kensho_kfinance-1.1.0a0/docs/llm_tools.rst

@@ -0,0 +1,7 @@
+llm_tools
+=========
+
+.. automodule:: kfinance.llm_tools
+   :members:
+   :undoc-members:
+   :inherited-members:

kensho_kfinance-1.1.0a0/docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx==8.1.3
+m2r2==0.3.3.post2
+sphinx-rtd-theme==3.0.2
+docutils==0.20

kensho_kfinance-1.1.0a0/docs/templates/apidoc/package.rst_t

@@ -0,0 +1,50 @@
+{% raw %}
+{%- macro automodule(modname, options) -%}
+.. automodule:: {{ modname }}
+{%- for option in options %}
+   :{{ option }}:
+{%- endfor %}
+{%- endmacro %}
+
+{%- macro toctree(docnames) -%}
+.. toctree::
+   :maxdepth: {{ maxdepth }}
+{% for docname in docnames %}
+   {{ docname }}
+{%- endfor %}
+{%- endmacro %}
+
+{%- if is_namespace %}
+{{- [pkgname, "namespace"] | join(" ") | e | heading }}
+{% else %}
+{{- [pkgname] | join(" ") | e | heading }}
+{% endif %}
+
+{%- if modulefirst and not is_namespace %}
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}
+
+{%- if subpackages %}
+{{ toctree(subpackages) }}
+{% endif %}
+
+{%- if submodules %}
+{% if separatemodules %}
+{{ toctree(submodules) }}
+{% else %}
+{%- for submodule in submodules %}
+{% if show_headings %}
+{{- [submodule] | join(" ") | e | heading(2) }}
+{% endif %}
+{{ automodule(submodule, automodule_options) }}
+{% endfor %}
+{%- endif %}
+{%- endif %}
+
+{%- if not modulefirst and not is_namespace %}
+Module contents
+---------------
+
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}
+{% endraw %}

kensho_kfinance-1.1.0a0/docs/templates/apidoc/toc.rst_t

@@ -0,0 +1,10 @@
+{% raw %}
+Index Tree
+==========
+
+.. toctree::
+   :maxdepth: {{ maxdepth }}
+{% for docname in docnames %}
+   {{ docname }}
+{%- endfor %}
+{% endraw %}

{kensho_kfinance-1.1.0 → kensho_kfinance-1.1.0a0}/justfile

@@ -29,3 +29,9 @@ alias t := unit-test
 # Run unit tests. Use args for optional settings
 unit-test *args:
     python -m pytest {{args}}
+
+# Build the sphinx documents locally
+# First, copy the dependencies in docs/requirements.txt into pyproject.toml and install in a venv.
+# Don't merge changes to pyproject and docs/output into the remote repo!
+sphinx *args:
+    sphinx-build docs docs/output

{kensho_kfinance-1.1.0 → kensho_kfinance-1.1.0a0}/kensho_kfinance.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 1.1.0
+Version: 1.1.0a0
 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-1.1.0 → kensho_kfinance-1.1.0a0}/kensho_kfinance.egg-info/SOURCES.txt

@@ -1,5 +1,6 @@
 .coveragerc
 .gitignore
+.readthedocs.yaml
 AUTHORS.md
 CODE_OF_CONDUCT.md
 CONTRIBUTING.md
@@ -11,9 +12,13 @@ setup.py
 .github/workflows/ci-lint.yml
 .github/workflows/ci-test.yml
 .github/workflows/python-publish.yml
+docs/conf.py
 docs/index.rst
 docs/kfinance.rst
 docs/llm_tools.rst
+docs/requirements.txt
+docs/templates/apidoc/package.rst_t
+docs/templates/apidoc/toc.rst_t
 kensho_kfinance.egg-info/PKG-INFO
 kensho_kfinance.egg-info/SOURCES.txt
 kensho_kfinance.egg-info/dependency_links.txt
@@ -36,5 +41,4 @@ kfinance/tests/test_fetch.py
 kfinance/tests/test_objects.py
 scripts/copyright_line_check.sh
 scripts/lint.sh
-scripts/test.sh
-scripts/docs/make_rst.py
+scripts/test.sh

{kensho_kfinance-1.1.0 → kensho_kfinance-1.1.0a0}/kfinance/llm_tools.py

@@ -31,23 +31,25 @@ class Model(Enum):
 
 
 def get_latest(use_local_timezone: bool = True) -> LatestPeriods:
-    """Get the latest annual reporting year, latest quarterly reporting quarter and year, and current date. The output is a dictionary with the following schema::
+    """Get the latest annual reporting year, latest quarterly reporting quarter and year, and current date.
 
-    {
-        "annual": {
-            "latest_year": int
-        },
-        "quarterly": {
-            "latest_quarter": int,
-            "latest_year": int
-        },
-        "now": {
-            "current_year": int,
-            "current_quarter": int,
-            "current_month": int,
-            "current_date": str # in format Y-m-d
+    The output is a dictionary with the following schema::
+
+        {
+            "annual": {
+                "latest_year": int
+            },
+            "quarterly": {
+                "latest_quarter": int,
+                "latest_year": int
+            },
+            "now": {
+                "current_year": int,
+                "current_quarter": int,
+                "current_month": int,
+                "current_date": str # in format Y-m-d
+            }
         }
-    }
 
     Args:
         use_local_timezone: whether to use the local timezone of the user
@@ -86,12 +88,14 @@ def get_latest(use_local_timezone: bool = True) -> LatestPeriods:
 
 
 def get_n_quarters_ago(n: int) -> YearAndQuarter:
-    """Get the year and quarter corresponding to [n] quarters before the current quarter. The output is a dictionary with the following schema::
+    """Get the year and quarter corresponding to [n] quarters before the current quarter.
 
-    {
-        "year": int,
-        "quarter": int
-    }
+    The output is a dictionary with the following schema::
+
+        {
+            "year": int,
+            "quarter": int
+        }
 
     Args:
         n: number of quarters before the current quarter

{kensho_kfinance-1.1.0 → kensho_kfinance-1.1.0a0}/kfinance/tool_schemas.py

@@ -16,7 +16,9 @@ class GetNQuartersAgoInput(BaseModel):
 
 
 class GetCompanyIdFromIdentifier(BaseModel):
-    ticker_str: str = Field(description="The ticker")
+    identifier: str = Field(
+        description="The identifier, which can be a ticker symbol, ISIN, or CUSIP"
+    )
 
 
 class GetSecurityIdFromIdentifier(BaseModel):

{kensho_kfinance-1.1.0 → kensho_kfinance-1.1.0a0}/kfinance/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.1.0'
+__version__ = version = '1.1.0a0'
 __version_tuple__ = version_tuple = (1, 1, 0)

kensho_kfinance-1.1.0/docs/index.rst

@@ -1,9 +0,0 @@
-Index
-#####################
-
-Documentation page for Kensho Finance library.
-
-.. toctree::
-
-    kfinance
-    llm_tools