kensho-kfinance 1.2.0__tar.gz → 1.2.2__tar.gz

{kensho_kfinance-1.2.0 → kensho_kfinance-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 1.2.0
+Version: 1.2.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
@@ -12,23 +12,25 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS.md
-Requires-Dist: python-dateutil<2.9,>=2.8.2
-Requires-Dist: requests<3,>=2.22.0
-Requires-Dist: urllib3>=1.21.1
-Requires-Dist: pyjwt>=2.8.0
+Requires-Dist: langchain-core>=0.3.15
 Requires-Dist: numpy>=1.22.4
 Requires-Dist: pandas>=2.0.0
-Requires-Dist: types-requests<3,>=2.22.0
 Requires-Dist: pillow>=10
-Requires-Dist: langchain-core>=0.3.15
+Requires-Dist: pydantic<3,>=2.10.0
+Requires-Dist: pyjwt>=2.8.0
+Requires-Dist: python-dateutil<2.9,>=2.8.2
 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
 Provides-Extra: dev
 Requires-Dist: coverage<8,>=7.6.10; extra == "dev"
 Requires-Dist: mypy<2,>=1.15.0; extra == "dev"
 Requires-Dist: pytest<7,>=6.1.2; extra == "dev"
 Requires-Dist: pytest-cov<7,>=6.0.0; extra == "dev"
-Requires-Dist: ruff<1,>=0.9.4; extra == "dev"
 Requires-Dist: requests_mock<1.2,>=1.1; extra == "dev"
+Requires-Dist: ruff<1,>=0.9.4; extra == "dev"
 Dynamic: license-file
 
 # kFinance

{kensho_kfinance-1.2.0 → kensho_kfinance-1.2.2}/kensho_kfinance.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 1.2.0
+Version: 1.2.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
@@ -12,23 +12,25 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS.md
-Requires-Dist: python-dateutil<2.9,>=2.8.2
-Requires-Dist: requests<3,>=2.22.0
-Requires-Dist: urllib3>=1.21.1
-Requires-Dist: pyjwt>=2.8.0
+Requires-Dist: langchain-core>=0.3.15
 Requires-Dist: numpy>=1.22.4
 Requires-Dist: pandas>=2.0.0
-Requires-Dist: types-requests<3,>=2.22.0
 Requires-Dist: pillow>=10
-Requires-Dist: langchain-core>=0.3.15
+Requires-Dist: pydantic<3,>=2.10.0
+Requires-Dist: pyjwt>=2.8.0
+Requires-Dist: python-dateutil<2.9,>=2.8.2
 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
 Provides-Extra: dev
 Requires-Dist: coverage<8,>=7.6.10; extra == "dev"
 Requires-Dist: mypy<2,>=1.15.0; extra == "dev"
 Requires-Dist: pytest<7,>=6.1.2; extra == "dev"
 Requires-Dist: pytest-cov<7,>=6.0.0; extra == "dev"
-Requires-Dist: ruff<1,>=0.9.4; extra == "dev"
 Requires-Dist: requests_mock<1.2,>=1.1; extra == "dev"
+Requires-Dist: ruff<1,>=0.9.4; extra == "dev"
 Dynamic: license-file
 
 # kFinance

{kensho_kfinance-1.2.0 → kensho_kfinance-1.2.2}/kensho_kfinance.egg-info/requires.txt

@@ -1,18 +1,20 @@
-python-dateutil<2.9,>=2.8.2
-requests<3,>=2.22.0
-urllib3>=1.21.1
-pyjwt>=2.8.0
+langchain-core>=0.3.15
 numpy>=1.22.4
 pandas>=2.0.0
-types-requests<3,>=2.22.0
 pillow>=10
-langchain-core>=0.3.15
+pydantic<3,>=2.10.0
+pyjwt>=2.8.0
+python-dateutil<2.9,>=2.8.2
 strenum>=0.4.15
+tabulate>=0.9.0
+types-requests<3,>=2.22.0
+requests<3,>=2.22.0
+urllib3>=1.21.1
 
 [dev]
 coverage<8,>=7.6.10
 mypy<2,>=1.15.0
 pytest<7,>=6.1.2
 pytest-cov<7,>=6.0.0
-ruff<1,>=0.9.4
 requests_mock<1.2,>=1.1
+ruff<1,>=0.9.4

{kensho_kfinance-1.2.0 → kensho_kfinance-1.2.2}/kfinance/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog
+
+## v1.2.2
+- Add tabulate and pydantic as dependencies
+
+## v1.2.1
+- Add fetch for industry_code, industry_classification and gics_code.
+
 ## v1.2.0
 - Add batch requests for iterable classes
 

{kensho_kfinance-1.2.0 → kensho_kfinance-1.2.2}/kfinance/constants.py

@@ -76,6 +76,17 @@ class LatestPeriods(TypedDict):
     now: CurrentPeriod
 
 
+class IndustryClassification(StrEnum):
+    sic = "sic"
+    naics = "naics"
+    nace = "nace"
+    anzsic = "anzsic"
+    spcapiqetf = "spcapiqetf"
+    spratings = "spratings"
+    gics = "gics"
+    simple = "simple"
+
+
 # all of these values must be lower case keys
 LINE_ITEMS: list[LineItemType] = [
     {

{kensho_kfinance-1.2.0 → kensho_kfinance-1.2.2}/kfinance/fetch.py

@@ -7,7 +7,7 @@ from uuid import uuid4
 import jwt
 import requests
 
-from .constants import BusinessRelationshipType, IdentificationTriple
+from .constants import BusinessRelationshipType, IdentificationTriple, IndustryClassification
 
 
 # version.py gets autogenerated by setuptools-scm and is not available
@@ -368,26 +368,6 @@ class KFinanceApiClient:
             country_iso_code=country_iso_code, state_iso_code=state_iso_code, fetch_ticker=False
         )
 
-    def fetch_simple_industry_groups(
-        self, simple_industry: str, fetch_ticker: bool = True
-    ) -> dict[str, list]:
-        """Fetch simple industry groups"""
-        url = f"{self.url_base}{'ticker_groups' if fetch_ticker else 'company_groups'}/industry/simple/{simple_industry}"
-        return self.fetch(url)
-
-    def fetch_ticker_simple_industry_groups(
-        self, simple_industry: str
-    ) -> dict[str, list[IdentificationTriple]]:
-        """Fetch ticker simple industry groups"""
-        return self.fetch_simple_industry_groups(simple_industry=simple_industry, fetch_ticker=True)
-
-    def fetch_company_simple_industry_groups(self, simple_industry: str) -> dict[str, list[int]]:
-        """Fetch company simple industry groups"""
-        return self.fetch_simple_industry_groups(
-            simple_industry=simple_industry,
-            fetch_ticker=False,
-        )
-
     def fetch_exchange_groups(
         self, exchange_code: str, fetch_ticker: bool = True
     ) -> dict[str, list]:
@@ -456,3 +436,56 @@ class KFinanceApiClient:
         """
         url = f"{self.url_base}relationship/{company_id}/{relationship_type}"
         return self.fetch(url)
+
+    def fetch_from_industry_code(
+        self,
+        industry_code: str,
+        industry_classification: IndustryClassification,
+        fetch_ticker: bool = True,
+    ) -> dict[str, list]:
+        """Fetches a list of companies or identification triples that are classified in the given industry_code and industry_classification."""
+
+        url = f"{self.url_base}{'ticker_groups' if fetch_ticker else 'company_groups'}/industry/{industry_classification}/{industry_code}"
+        return self.fetch(url)
+
+    def fetch_ticker_from_industry_code(
+        self,
+        industry_code: str,
+        industry_classification: IndustryClassification,
+    ) -> dict[str, list[IdentificationTriple]]:
+        """Fetches a list of identification triples that are classified in the given industry_code and industry_classification.
+
+        Returns a dictionary of shape {"tickers": List[{“company_id”: <company_id>, “security_id”: <security_id>, “trading_item_id”: <trading_item_id>}]}.
+        :param industry_code: The industry_code to filter on. The industry_code is a string corresponding to the Industry classifications ontology.
+        :type industry_code: str
+        :param industry_classification: The type of industry_classification to filter on.
+        :type industry_classification: IndustryClassification
+        :return: A dictionary containing the list of identification triple [company_id, security_id, trading_item_id] that are classified in the given industry_code and industry_classification.
+        :rtype: dict[str, list[IdentificationTriple]]
+        """
+        return self.fetch_from_industry_code(
+            industry_code=industry_code,
+            industry_classification=industry_classification,
+            fetch_ticker=True,
+        )
+
+    def fetch_company_from_industry_code(
+        self,
+        industry_code: str,
+        industry_classification: IndustryClassification,
+    ) -> dict[str, list[int]]:
+        """Fetches a list of companies that are classified in the given industry_code and industry_classification.
+
+        Returns a dictionary of shape {"companies": List[<company_id>]}.
+        :param industry_code: The industry_code to filter on. The industry_code is a string corresponding to the Industry classifications ontology.
+        :type industry_code: str
+        :param industry_classification: The type of industry_classification to filter on.
+        :type industry_classification: IndustryClassification
+        :return: A dictionary containing the list of companies that are classified in the given industry_code and industry_classification.
+        :rtype: dict[str, list[int]]
+        """
+        return self.fetch_from_industry_code(
+            industry_code=industry_code,
+            industry_classification=industry_classification,
+            fetch_ticker=False,
+        )

{kensho_kfinance-1.2.0 → kensho_kfinance-1.2.2}/kfinance/tests/test_fetch.py

@@ -157,26 +157,6 @@ class TestFetchItem(TestCase):
         )
         self.kfinance_api_client.fetch.assert_called_with(expected_fetch_url)
 
-    def test_fetch_ticker_industry_simple_groups(self) -> None:
-        simple_industry = "media"
-        expected_fetch_url = (
-            f"{self.kfinance_api_client.url_base}ticker_groups/industry/simple/{simple_industry}"
-        )
-        self.kfinance_api_client.fetch_ticker_simple_industry_groups(
-            simple_industry=simple_industry
-        )
-        self.kfinance_api_client.fetch.assert_called_once_with(expected_fetch_url)
-
-    def test_fetch_company_industry_simple_groups(self) -> None:
-        simple_industry = "media"
-        expected_fetch_url = (
-            f"{self.kfinance_api_client.url_base}company_groups/industry/simple/{simple_industry}"
-        )
-        self.kfinance_api_client.fetch_company_simple_industry_groups(
-            simple_industry=simple_industry
-        )
-        self.kfinance_api_client.fetch.assert_called_once_with(expected_fetch_url)
-
     def test_fetch_ticker_exchange_groups(self) -> None:
         exchange_code = "NYSE"
         expected_fetch_url = (

{kensho_kfinance-1.2.0 → kensho_kfinance-1.2.2}/kfinance/version.py

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

{kensho_kfinance-1.2.0 → kensho_kfinance-1.2.2}/pyproject.toml

@@ -16,17 +16,20 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 
+
 dependencies = [
-    "python-dateutil>=2.8.2,<2.9",
-    "requests>=2.22.0,<3",
-    "urllib3>=1.21.1",
-    "pyjwt>=2.8.0",
+    "langchain-core>=0.3.15",
     "numpy>=1.22.4",
     "pandas>=2.0.0",
-    "types-requests>=2.22.0,<3",
     "pillow>=10",
-    "langchain-core>=0.3.15",
+    "pydantic>=2.10.0,<3",
+    "pyjwt>=2.8.0",
+    "python-dateutil>=2.8.2,<2.9",
     "strenum>=0.4.15",
+    "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",
 ]
 
 [project.optional-dependencies]
@@ -35,8 +38,8 @@ dev = [
     "mypy>=1.15.0,<2",
     "pytest>=6.1.2,<7",
     "pytest-cov>=6.0.0,<7",
-    "ruff>=0.9.4,<1",
     "requests_mock>=1.1,<1.2",
+    "ruff>=0.9.4,<1",
 ]
 
 [project.urls]