earningscall 0.0.12__py3-none-any.whl → 0.0.14__py3-none-any.whl

earningscall/__init__.py

@@ -4,5 +4,6 @@ from earningscall.exports import get_company, get_all_companies, get_sp500_compa
 from earningscall.symbols import Symbols, load_symbols
 
 api_key: Optional[str] = None
+enable_requests_cache: bool = True
 
 __all__ = ["get_company", "get_all_companies", "get_sp500_companies", "Symbols", "load_symbols"]

earningscall/api.py

@@ -3,6 +3,7 @@ import os
 from typing import Optional
 
 import requests
+from requests_cache import CachedSession
 
 import earningscall
 
@@ -27,15 +28,45 @@ def is_demo_account():
     return get_api_key() == "demo"
 
 
-def get_events(exchange: str, symbol: str):
+def cache_session() -> CachedSession:
+    return CachedSession(
+        ".earningscall_cache",
+        backend="sqlite",
+        cache_control=True,
+        use_temp=True,
+        ignored_parameters=['apikey'],
+    )
+
+
+def cached_urls():
+    return cache_session().cache.urls()
+
+
+def purge_cache():
+    return cache_session().cache.clear()
+
+
+def do_get(path: str, use_cache: bool = False, **kwargs):
+    params = {
+        **api_key_param(),
+        **kwargs.get("params", {}),
+    }
+    url = f"{API_BASE}/{path}"
+    log.debug(f"do_get url: {url} params: {params}")
+    if use_cache and earningscall.enable_requests_cache:
+        return cache_session().get(url, params=params)
+    else:
+        return requests.get(url, params=params)
 
+
+def get_events(exchange: str, symbol: str):
     log.debug(f"get_events exchange: {exchange} symbol: {symbol}")
     params = {
         **api_key_param(),
         "exchange": exchange,
         "symbol": symbol,
     }
-    response = requests.get(f"{API_BASE}/events", params=params)
+    response = do_get("events", params=params)
     if response.status_code != 200:
         return None
     return response.json()
@@ -51,34 +82,23 @@ def get_transcript(exchange: str, symbol: str, year: int, quarter: int) -> Optio
         "year": str(year),
         "quarter": str(quarter),
     }
-    response = requests.get(f"{API_BASE}/transcript", params=params)
+    response = do_get("transcript", params=params)
     if response.status_code != 200:
         return None
     return response.json()
 
 
-def get_symbols_v1():
-    response = requests.get(f"{API_BASE}/symbols.txt")
-    if response.status_code != 200:
-        return None
-    return response.text
-
-
 def get_symbols_v2():
-    response = requests.get(f"{API_BASE}/symbols-v2.txt", params=api_key_param())
+    log.debug("get_symbols_v2")
+    response = do_get("symbols-v2.txt", use_cache=True)
     if response.status_code != 200:
         return None
     return response.text
 
 
 def get_sp500_companies_txt_file():
-    response = requests.get(f"{API_BASE}/symbols/sp500.txt", params=api_key_param())
+    log.debug("get_sp500_companies_txt_file")
+    response = do_get("symbols/sp500.txt", use_cache=True)
     if response.status_code != 200:
         return None
     return response.text
-
-
-# def do_something():
-#     session = CachedSession('demo_cache', cache_control=True)
-#
-#     # CachedSession()

earningscall/sectors.py

@@ -1,6 +1,4 @@
-import json
 import logging
-from typing import Optional
 
 log = logging.getLogger(__file__)
 sectors_file_name = "sectors.json"
@@ -179,14 +177,20 @@ def sector_to_index(_sector: str) -> int:
 
 def index_to_sector(_index: int) -> str:
     if _index == -1:
-        return "UNKNOWN"
-    return SECTORS_IN_ORDER[_index]
+        return "Unknown"
+    try:
+        return SECTORS_IN_ORDER[_index]
+    except IndexError:
+        return "Unknown"
 
 
 def index_to_industry(_index: int) -> str:
     if _index == -1:
-        return "UNKNOWN"
-    return INDUSTRIES_IN_ORDER[_index]
+        return "Unknown"
+    try:
+        return INDUSTRIES_IN_ORDER[_index]
+    except IndexError:
+        return "Unknown"
 
 
 def industry_to_index(_industry: str) -> int:
@@ -194,38 +198,3 @@ def industry_to_index(_industry: str) -> int:
         return INDUSTRIES_IN_ORDER.index(_industry)
     except ValueError:
         return -1
-
-
-class Sectors:
-
-    def __init__(self, sectors: Optional[set] = None, industries: Optional[set] = None):
-        if sectors:
-            self.sectors = sectors
-        else:
-            self.sectors = set()
-        if industries:
-            self.industries = industries
-        else:
-            self.industries = set()
-
-    def add_sector(self, sector: str):
-        if sector is not None:
-            self.sectors.add(sector)
-
-    def add_industry(self, industry: str):
-        if industry is not None:
-            self.industries.add(industry)
-
-    def to_dicts(self) -> dict:
-        return {
-            "sectors": list(self.sectors),
-            "industries": list(self.industries),
-        }
-
-    def to_json(self) -> str:
-        return json.dumps(self.to_dicts())
-
-    @staticmethod
-    def from_json(json_str):
-        data = json.loads(json_str)
-        return Sectors(set(data["sectors"]), set(data["industries"]))

earningscall/symbols.py

@@ -1,6 +1,5 @@
 import json
 import logging
-import re
 from collections import defaultdict
 from typing import Optional, Iterator, List
 
@@ -26,7 +25,10 @@ def exchange_to_index(_exchange: Optional[str]) -> int:
 def index_to_exchange(_index: int) -> str:
     if _index == -1:
         return "UNKNOWN"
-    return EXCHANGES_IN_ORDER[_index]
+    try:
+        return EXCHANGES_IN_ORDER[_index]
+    except IndexError:
+        return "UNKNOWN"
 
 
 security_type_pattern = {
@@ -47,21 +49,12 @@ class CompanyInfo:
 
     def __init__(self, **kwargs):
         self.exchange = None
+        self.symbol = None
         self.name = None
-        self.security_name = None
         self.sector = None
         self.industry = None
         for key, value in kwargs.items():
             self.__setattr__(key, value)
-        # If name is not set upon initialization, we'll set it from the security name.  Also, include
-        # sanitization (removing "Common Stock" from the security name for example)
-        if not self.name:
-            if self.exchange == "OTC":
-                self.security_name = self.security_name.title()
-            if self.exchange in security_type_pattern:
-                self.name = re.sub(security_type_pattern[self.exchange], "", self.security_name)
-            else:
-                self.name = self.security_name
 
     def __str__(self):
         return f"({self.exchange}: {self.symbol} - {self.name})"
@@ -160,20 +153,6 @@ class Symbols:
             return json.dumps(self.without_security_names())
         return json.dumps(self.to_dicts())
 
-    # TODO: Test this
-    # def to_json_v2(self) -> str:
-    #     return json.dumps(
-    #         [
-    #             [exchange_to_index(__symbol.exchange), __symbol.company_info, __symbol.name]
-    #             for __symbol in self.get_all()
-    #         ]
-    #     )
-
-    def to_txt(self) -> str:
-        exchange_symbol_names = [__symbol.to_txt_row() for __symbol in self.get_all()]
-        sorted_rows = sorted(exchange_symbol_names, key=lambda row: row[1])
-        return "\n".join(["\t".join(row) for row in sorted_rows])
-
     def to_txt_v2(self) -> str:
         exchange_symbol_names = [__symbol.to_txt_v2_row() for __symbol in self.get_all()]
         sorted_rows = sorted(exchange_symbol_names, key=lambda row: row[1])
@@ -186,21 +165,6 @@ class Symbols:
             __symbols.add(CompanyInfo(**item))
         return __symbols
 
-    @staticmethod
-    def from_json_v2(json_str):
-        __symbols = Symbols()
-        for [_exchange_index, _symbol, _name] in json.loads(json_str):
-            __symbols.add(CompanyInfo(exchange=index_to_exchange(_exchange_index), symbol=_symbol, name=_name))
-        return __symbols
-
-    @staticmethod
-    def from_txt(txt_str):
-        __symbols = Symbols()
-        for line in txt_str.split("\n"):
-            _exchange_index, _symbol, _name = line.split("\t")
-            __symbols.add(CompanyInfo(exchange=index_to_exchange(int(_exchange_index)), symbol=_symbol, name=_name))
-        return __symbols
-
     @staticmethod
     def from_txt_v2(txt_str):
         __symbols = Symbols()

{earningscall-0.0.12.dist-info → earningscall-0.0.14.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.3
 Name: earningscall
-Version: 0.0.12
-Summary: The EarningsCall Python library.
+Version: 0.0.14
+Summary: The EarningsCall Python library provides convenient access to the EarningsCall API.  It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses.
 Project-URL: Homepage, https://earningscall.biz
 Project-URL: Documentation, https://github.com/EarningsCall/earningscall-python
 Project-URL: Repository, https://github.com/EarningsCall/earningscall-python
@@ -31,6 +31,18 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
 License-File: LICENSE
+Keywords: earnings call,earnings call transcripts,earnings calls,transcripts
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
 Requires-Python: >=3.8
 Requires-Dist: dataclasses-json>=0.6.4
 Requires-Dist: dataclasses>=0.6
@@ -40,15 +52,20 @@ Description-Content-Type: text/markdown
 
 # EarningsCall Python Library
 
-[![pypi](https://img.shields.io/pypi/v/earningscall.svg)](https://pypi.python.org/pypi/earningscall)
+[![pypi](https://img.shields.io/pypi/v/earningscall.svg)](https://pypi.org/project/earningscall/)
 [![Build Status](https://github.com/EarningsCall/earningscall-python/actions/workflows/release.yml/badge.svg?branch=master)](https://github.com/EarningsCall/earningscall-python/actions?query=branch%3Amaster)
 [![Coverage Status](https://coveralls.io/repos/github/EarningsCall/earningscall-python/badge.svg?branch=master)](https://coveralls.io/github/EarningsCall/earningscall-python?branch=master)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/earningscall?color=blue)](https://pypi.org/project/earningscall/)
 
 The EarningsCall Python library provides convenient access to the [EarningsCall API](https://earningscall.biz/api-guide) from
 applications written in the Python language. It includes a pre-defined set of
 classes for API resources that initialize themselves dynamically from API
 responses.
 
+# Requirements
+
+* Python 3.8+
+
 # Installation
 
 You don't need this source code unless you want to modify the package. If you just want to use the package, just run:
@@ -57,10 +74,6 @@ You don't need this source code unless you want to modify the package. If you ju
 pip install --upgrade earningscall
 ```
 
-# Requirements
-
-* Python 3.8+ (PyPI supported)
-
 ## Get Transcript for a Single Quarter
 
 ```python
@@ -151,3 +164,18 @@ for company in get_sp500_companies():
     print(f"{company.company_info} -- {company.company_info.sector} -- {company.company_info.industry}")
 ```
 
+
+## Advanced
+
+### Disable Caching
+
+When you call `get_company("aapl")` to retrieve a company, internally the library retrieves metadata
+from the EarningsCall API.  By default, it caches this metadata on disk in order to speed up subsequent requests.
+
+If you prefer to disable this local caching behavior, you can do so with this code:
+
+```python
+import earningscall
+
+earningscall.enable_requests_cache = False
+```

earningscall-0.0.14.dist-info/RECORD

@@ -0,0 +1,14 @@
+earningscall/__init__.py,sha256=0mANmPlE7LEWtOGzV2cmmlPfBIWBWlWRDkyqPHJ1jm8,333
+earningscall/api.py,sha256=guyKJCg949sRYP9FuIUfgo93u6jfC_9wSgJBXVAEwIg,2496
+earningscall/company.py,sha256=ZNF75htXg37oXtNzwrHH8DoTdyFJ3PBB9qSNBp_vo8c,1943
+earningscall/errors.py,sha256=EA-d6qIYgQs9csp8JptQiAaYoM0M9HhCGJgKA9GAWPg,440
+earningscall/event.py,sha256=O7KAE2wO3mBhlEWIFA1choMNGRthYd0gBIvVQOmVALs,692
+earningscall/exports.py,sha256=i9UWHY6Lq1OzZTZX_1SdNzrNd_PSlPwpB337lGMK4oM,837
+earningscall/sectors.py,sha256=Xd6DLkAQ_fQkC2s-N9pReC8b_M3iy77OoFftoZj9FWY,5114
+earningscall/symbols.py,sha256=Fsk9F2SYzn5TUQnL84AO1_xgiMg6G1DyvBGm7-_3LH4,6347
+earningscall/transcript.py,sha256=rLH2bGrrgUmS8XZGAPUP7msiIcL7f4ABmbnVJWXI28c,329
+earningscall/utils.py,sha256=Qx8KhlumUdzyBSZRKMS6vpWlb8MGZpLKA4OffJaMdCE,1032
+earningscall-0.0.14.dist-info/METADATA,sha256=n7yhm8mMOfEblfEMjNsRMD1WM8LXB4kQlsRt_IY4Dpo,7014
+earningscall-0.0.14.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
+earningscall-0.0.14.dist-info/licenses/LICENSE,sha256=ktEB_UcRMg2cQlX9wiDs544xWncWizwS9mEZuGsCLrM,1069
+earningscall-0.0.14.dist-info/RECORD,,

earningscall-0.0.12.dist-info/RECORD

@@ -1,14 +0,0 @@
-earningscall/__init__.py,sha256=NX9f2et-q3p8BRGvJB0enRSLlSGecSAwspPxhDsL95Y,298
-earningscall/api.py,sha256=eK43JazoBNI9YF0OMi5c0DrYv0tVzyOy2ycNyX63y8s,2000
-earningscall/company.py,sha256=ZNF75htXg37oXtNzwrHH8DoTdyFJ3PBB9qSNBp_vo8c,1943
-earningscall/errors.py,sha256=EA-d6qIYgQs9csp8JptQiAaYoM0M9HhCGJgKA9GAWPg,440
-earningscall/event.py,sha256=O7KAE2wO3mBhlEWIFA1choMNGRthYd0gBIvVQOmVALs,692
-earningscall/exports.py,sha256=i9UWHY6Lq1OzZTZX_1SdNzrNd_PSlPwpB337lGMK4oM,837
-earningscall/sectors.py,sha256=9kAwTtJEDbWah6lz5io88qRwvCtmGgjQ-MU7rayTmVI,5962
-earningscall/symbols.py,sha256=EXSPUMr50zZz-Cw9CimrRbVd7F71PB9McgsFC7yJ5S4,7980
-earningscall/transcript.py,sha256=rLH2bGrrgUmS8XZGAPUP7msiIcL7f4ABmbnVJWXI28c,329
-earningscall/utils.py,sha256=Qx8KhlumUdzyBSZRKMS6vpWlb8MGZpLKA4OffJaMdCE,1032
-earningscall-0.0.12.dist-info/METADATA,sha256=Br6DJz0J0ZVy4FrY6qkSYcFoze_unf2ooht9v7D__UQ,5714
-earningscall-0.0.12.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-earningscall-0.0.12.dist-info/licenses/LICENSE,sha256=ktEB_UcRMg2cQlX9wiDs544xWncWizwS9mEZuGsCLrM,1069
-earningscall-0.0.12.dist-info/RECORD,,