kensho-kfinance 1.2.0__py3-none-any.whl → 1.2.2__py3-none-any.whl

{kensho_kfinance-1.2.0.dist-info → kensho_kfinance-1.2.2.dist-info}/METADATA

@@ -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.dist-info → kensho_kfinance-1.2.2.dist-info}/RECORD

@@ -1,10 +1,10 @@
-kensho_kfinance-1.2.0.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
-kensho_kfinance-1.2.0.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
-kfinance/CHANGELOG.md,sha256=rPeMYaICQiwXrL3vPgLjanjulnxVyovt27dLFqqZ_RA,443
+kensho_kfinance-1.2.2.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
+kensho_kfinance-1.2.2.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
+kfinance/CHANGELOG.md,sha256=2s4rnko1N6MDMK38Bn0OUvhHSygSGb2XGQgM1kKEUtc,580
 kfinance/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/batch_request_handling.py,sha256=s0uXRY4CC-GnShI0i8PLPgLddRdqLyQ8jnqDKdmaZzs,5531
-kfinance/constants.py,sha256=SJfI3K2gS0N-M3-rHIMizcxjyTz_iWBc7UYtauUOjDg,47338
-kfinance/fetch.py,sha256=tDPFQQSPMAAnH8gFlT1dgERaHRfQjkW2zcUYcRFbXEY,18130
+kfinance/constants.py,sha256=uopijPmpAU97l9OA_mllG2UvGHP9-zeq0UqkA7Yrk-w,47553
+kfinance/fetch.py,sha256=XrkOC_5RsiI_ycRiaBbhrs1ND-gqBOknWmfIOpDSLRI,20114
 kfinance/kfinance.py,sha256=PGJzfq_AdX7IZsY4BpNuni90R6SGa6nrNLicJi_QEec,45643
 kfinance/llm_tools.py,sha256=t3i-5y34AzeFujjwOJVWY7OFI5aOAWG8rt-9KgR_0-E,30683
 kfinance/meta_classes.py,sha256=ryncusGDe48gG31a-Ldx1ApJ-ZPRFJvjC18jry7TOVE,15980
@@ -12,12 +12,12 @@ kfinance/prompt.py,sha256=PtVB8c_FcSlVdyGgByAnIFGzuUuBaEjciCqnBJl1hSQ,25133
 kfinance/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/server_thread.py,sha256=jUnt1YGoYDkqqz1MbCwd44zJs1T_Z2BCgvj75bdtLgA,2574
 kfinance/tool_schemas.py,sha256=JrFSbb6i2lOQaI24QqnhGhZ3e-pWLhjNqZloY9WGlnM,5643
-kfinance/version.py,sha256=V2bJXGFUmn_IdFy3HF4zr3V9woAW6i1X0GXwu8-ZCDs,511
+kfinance/version.py,sha256=o0zEAUXpMoJZCULVYplCdjcZuIQ-3sIIZKyfNu_loQE,511
 kfinance/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/tests/test_batch_requests.py,sha256=NsldoZqjjQpv0QKM2th80F1nru2tIF4LJeXU-RamQvA,9836
-kfinance/tests/test_fetch.py,sha256=gYSYDSsMUHpwwMODN0_g7kQQAEWq_jsucIRiqhBjAcA,12981
+kfinance/tests/test_fetch.py,sha256=6au-TrsLbLoyvgd1vZSMlxOtXrau8ptM4tcS7vPXIzA,12088
 kfinance/tests/test_objects.py,sha256=egXkhfoK2MepZdXtrBxzWxWni7f-zVCefUbnyDnWDOE,22554
-kensho_kfinance-1.2.0.dist-info/METADATA,sha256=ACI6Utx34JrW1rSNX97cMyDlHq8L_rsQAh7SH9PXWB8,2869
-kensho_kfinance-1.2.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-kensho_kfinance-1.2.0.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
-kensho_kfinance-1.2.0.dist-info/RECORD,,
+kensho_kfinance-1.2.2.dist-info/METADATA,sha256=1OzzFZCWvGJEYcKJGURgJjgZ_awy66sdEKqxSpfpuGE,2935
+kensho_kfinance-1.2.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+kensho_kfinance-1.2.2.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
+kensho_kfinance-1.2.2.dist-info/RECORD,,

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
 

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] = [
     {

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,
+        )

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 = (

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)