earningscall 0.0.13__tar.gz → 0.0.14__tar.gz

earningscall-0.0.14/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Release `0.0.14` - 2024-06-08
+* Add caching to improve client performance.
+* Add `company_info` attribute in `Company` class.

{earningscall-0.0.13 → earningscall-0.0.14}/DEVELOPMENT.md

@@ -1,6 +1,46 @@
 # Development
 
-TODO: Add hatch installation instructions.
+First, install Hatch.  See the Hatch [installation instructions](https://hatch.pypa.io/latest/install/).
+
+
+## Run Build
+
+```shell
+hatch build
+```
+
+
+### Running Unit Tests
+
+```shell
+hatch run test
+```
+
+### Run Test Coverage Report
+
+
+```shell
+hatch run cov
+```
+
+Or, generate HTML report locally:
+
+```shell
+coverage html
+```
+
+### Run Linter
+
+```shell
+hatch run lint:all
+```
+
+If you get linter errors, you can automatically fix them by running this command:
+
+```shell
+hatch run lint:fmt
+```
+
 
 
 ### Saving Server-Side Responses for a Mocked Unit test

{earningscall-0.0.13 → earningscall-0.0.14}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.3
 Name: earningscall
-Version: 0.0.13
-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+
-
 ## Get Transcript for a Single Quarter
 
 ```python
@@ -150,3 +163,19 @@ from earningscall import get_sp500_companies
 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.13 → earningscall-0.0.14}/README.md

@@ -1,14 +1,19 @@
 # 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:
@@ -17,10 +22,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+
-
 ## Get Transcript for a Single Quarter
 
 ```python
@@ -110,3 +111,19 @@ from earningscall import get_sp500_companies
 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/TODO.md

@@ -0,0 +1,11 @@
+
+# ToDos
+
+* Add ability to retrieve advanced transcript data
+* Raise helpful error if the user tries to make a call that the current plan doesn't support
+* Add documentation on how to disable caching
+
+
+# Considerations
+
+* Consider implementing @dataclass and @dataclass_json from scratch to avoid third-party dependency

{earningscall-0.0.13 → earningscall-0.0.14}/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-0.0.13 → earningscall-0.0.14}/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-0.0.13 → earningscall-0.0.14}/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-0.0.13 → earningscall-0.0.14}/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.13 → earningscall-0.0.14}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "earningscall"
-version = "0.0.13"
-description = "The EarningsCall Python library."
+version = "0.0.14"
+description = "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."
 readme = "README.md"
 authors = [
     {name = "EarningsCall", email = "dev@earningscall.biz"},
@@ -14,6 +14,35 @@ dependencies = [
     "requests-cache>=1.2.0",
 ]
 license = { file = "LICENSE" }
+keywords = [
+    "earnings calls",
+    "earnings call",
+    "earnings call transcripts",
+    "transcripts",
+]
+classifiers = [
+    # How mature is this project? Common values are
+    #   3 - Alpha
+    #   4 - Beta
+    #   5 - Production/Stable
+    "Development Status :: 3 - Alpha",
+
+    # Indicate who your project is intended for
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+
+    # Pick your license as you wish (see also "license" above)
+    "License :: OSI Approved :: MIT License",
+
+    # Specify the Python versions you support here.
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
 
 [project.urls]
 Homepage = "https://earningscall.biz"

earningscall-0.0.14/tests/data/msft-company-events.yaml

@@ -0,0 +1,28 @@
+responses:
+- response:
+    auto_calculate_content_length: false
+    body: '{"company_name": "Microsoft Corporation", "events": [{"year": 2024, "quarter":
+      3, "conference_date": "2024-04-25T17:30:00.000-04:00"}, {"year": 2024, "quarter":
+      2, "conference_date": "2024-01-30T17:30:00.000-05:00"}, {"year": 2024, "quarter":
+      1, "conference_date": "2023-10-24T14:30:00.000-07:00"}, {"year": 2023, "quarter":
+      4, "conference_date": "2023-07-25T14:30:00.000-07:00"}, {"year": 2023, "quarter":
+      3, "conference_date": "2023-04-25T14:30:00.000-07:00"}, {"year": 2023, "quarter":
+      2, "conference_date": "2023-01-24T14:30:00.000-08:00"}, {"year": 2023, "quarter":
+      1, "conference_date": "2022-10-25T09:00:00.000-04:00"}, {"year": 2022, "quarter":
+      4, "conference_date": "2022-07-26T09:00:00.000-04:00"}, {"year": 2022, "quarter":
+      3, "conference_date": "2022-04-26T14:30:00.000-07:00"}, {"year": 2022, "quarter":
+      2, "conference_date": "2022-01-25T14:30:00.000-08:00"}, {"year": 2022, "quarter":
+      1, "conference_date": "2021-10-26T14:30:00.000-07:00"}, {"year": 2021, "quarter":
+      4, "conference_date": "2021-07-27T14:30:00.000-07:00"}, {"year": 2021, "quarter":
+      3, "conference_date": "2021-04-29T14:30:00.000-07:00"}, {"year": 2021, "quarter":
+      2, "conference_date": "2021-01-26T14:30:00.000-08:00"}, {"year": 2021, "quarter":
+      1, "conference_date": "2020-10-27T14:30:00.000-07:00"}, {"year": 2020, "quarter":
+      4, "conference_date": "2020-07-22T14:30:00.000-07:00"}, {"year": 2020, "quarter":
+      3, "conference_date": "2020-04-29T14:30:00.000-05:00"}, {"year": 2020, "quarter":
+      2, "conference_date": "2020-01-29T14:30:00.000-08:00"}, {"year": 2020, "quarter":
+      1, "conference_date": "2019-10-23T14:30:00.000-07:00"}, {"year": 2019, "quarter":
+      4, "conference_date": "2019-07-18T14:30:00.000-07:00"}]}'
+    content_type: text/plain
+    method: GET
+    status: 200
+    url: https://v2.api.earningscall.biz/events?apikey=demo&exchange=NASDAQ&symbol=MSFT

earningscall-0.0.14/tests/data/symbols-v2-missing-edge-cases.yaml

@@ -0,0 +1,10 @@
+responses:
+- response:
+    auto_calculate_content_length: false
+    body: "99999\tA\tAgilent Technologies, Inc.\t9999\t99999\n-1\tAA\tAlcoa Corporation\t-1\t\
+      -1\n-1\tAAB\tAberdeen International Inc.\t-1\t-1\n1\tAACG\tATA Creativity Global\t\
+      3\t38"
+    content_type: text/plain
+    method: GET
+    status: 200
+    url: https://v2.api.earningscall.biz/symbols-v2.txt

earningscall-0.0.14/tests/test_get_company_events.py

@@ -0,0 +1,32 @@
+import responses
+
+from earningscall import get_company
+from earningscall.api import purge_cache
+from earningscall.symbols import clear_symbols
+from earningscall.utils import data_path
+
+
+# Uncomment and run following code to generate msft-transcript-response.yaml file
+#
+# from responses import _recorder
+# @_recorder.record(file_path="msft-company-events.yaml")
+# def test_save_symbols_v1():
+#     requests.get("https://v2.api.earningscall.biz/events?apikey=demo&exchange=NASDAQ&symbol=MSFT")
+#
+
+
+@responses.activate
+def test_get_demo_company():
+    ##
+    purge_cache()
+    clear_symbols()
+    responses._add_from_file(file_path=data_path("symbols-v2.yaml"))
+    responses._add_from_file(file_path=data_path("msft-transcript-response.yaml"))
+    responses._add_from_file(file_path=data_path("msft-company-events.yaml"))
+    ##
+    company = get_company("msft")
+    events = company.events()
+    ##
+    assert len(events) == 20
+    assert events[0].year == 2024
+    assert events[0].quarter == 3

earningscall-0.0.14/tests/test_get_sp500_companies_api.py

@@ -0,0 +1,62 @@
+import time
+
+import responses
+
+from earningscall.api import get_sp500_companies_txt_file, cached_urls, purge_cache
+
+
+@responses.activate
+def test_load_sp500_tickers():
+    purge_cache()
+    assert len(cached_urls()) == 0
+    ##
+    responses.add(
+        responses.GET,
+        "https://v2.api.earningscall.biz/symbols/sp500.txt?apikey=demo",
+        body="AAPL\nMSFT\nTSLA",
+        status=200,
+        adding_headers={
+            "Cache-Control": "public, max-age=3",  # Allow client to cache for 3 seconds
+        },
+    )
+    responses.add(
+        responses.GET,
+        "https://v2.api.earningscall.biz/symbols/sp500.txt?apikey=demo",
+        body="AAPL\nMSFT\nTSLA\nNEWCOMPANY",
+        status=200,
+        adding_headers={
+            "cache-control": "public, max-age=30",  # Allow client to cache for 30 seconds
+        },
+    )
+    ##
+    sp500_raw_text = get_sp500_companies_txt_file()
+    ##
+    assert len(responses.calls) == 1
+    assert responses.calls[0].request.url == "https://v2.api.earningscall.biz/symbols/sp500.txt?apikey=demo"
+    assert cached_urls() == ["https://v2.api.earningscall.biz/symbols/sp500.txt?apikey=REDACTED"]
+    tickers = [ticker_symbol for ticker_symbol in sp500_raw_text.split("\n")]
+    assert tickers == ["AAPL", "MSFT", "TSLA"]
+    ##
+    # Request a second time, should serve out of cache
+    ##
+    sp500_raw_text = get_sp500_companies_txt_file()
+    ##
+    assert len(responses.calls) == 1
+    assert responses.calls[0].request.url == "https://v2.api.earningscall.biz/symbols/sp500.txt?apikey=demo"
+    urls = cached_urls()
+    assert urls == ["https://v2.api.earningscall.biz/symbols/sp500.txt?apikey=REDACTED"]
+    tickers = [ticker_symbol for ticker_symbol in sp500_raw_text.split("\n")]
+    assert tickers == ["AAPL", "MSFT", "TSLA"]
+    ##
+    # Wait enough time for cache entry to expire
+    ##
+    time.sleep(4)
+    ##
+    sp500_raw_text = get_sp500_companies_txt_file()
+    ##
+    assert len(responses.calls) == 2
+    assert responses.calls[0].request.url == "https://v2.api.earningscall.biz/symbols/sp500.txt?apikey=demo"
+    assert responses.calls[1].request.url == "https://v2.api.earningscall.biz/symbols/sp500.txt?apikey=demo"
+    assert cached_urls() == ["https://v2.api.earningscall.biz/symbols/sp500.txt?apikey=REDACTED"]
+    tickers = [ticker_symbol for ticker_symbol in sp500_raw_text.split("\n")]
+    assert tickers == ["AAPL", "MSFT", "TSLA", "NEWCOMPANY"]

{earningscall-0.0.13 → earningscall-0.0.14}/tests/test_get_transcript.py

@@ -2,6 +2,7 @@ import pytest
 import responses
 
 from earningscall import get_company
+from earningscall.api import purge_cache
 from earningscall.errors import InsufficientApiAccessError
 from earningscall.symbols import clear_symbols
 from earningscall.utils import data_path
@@ -18,6 +19,7 @@ from earningscall.utils import data_path
 @responses.activate
 def test_get_demo_company():
     ##
+    purge_cache()
     clear_symbols()
     responses._add_from_file(file_path=data_path("symbols-v2.yaml"))
     responses._add_from_file(file_path=data_path("msft-transcript-response.yaml"))
@@ -33,6 +35,7 @@ def test_get_demo_company():
 @responses.activate
 def test_get_demo_company_with_event_populated():
     ##
+    purge_cache()
     clear_symbols()
     responses._add_from_file(file_path=data_path("symbols-v2.yaml"))
     responses._add_from_file(file_path=data_path("demo-symbols-v2-alpha.yaml"))
@@ -75,6 +78,7 @@ def test_get_demo_company_with_event_populated():
 @responses.activate
 def test_get_non_demo_company():
     ##
+    purge_cache()
     clear_symbols()
     responses._add_from_file(file_path=data_path("demo-symbols-v2.yaml"))
     ##

earningscall-0.0.14/tests/test_responses_mocking.py

@@ -0,0 +1,34 @@
+import requests
+import responses
+
+
+# NOTE: this test is only testing the behavior of the responses library, and therefore it is not testing any
+#       code in earningscall at all.
+
+
+@responses.activate
+def test_load_sp500_tickers():
+    ##
+    responses.add(
+        responses.GET,
+        "http://www.example.com",
+        body="first response",
+        status=200,
+    )
+    responses.add(
+        responses.GET,
+        "http://www.example.com",
+        body="second response",
+        status=200,
+    )
+    ##
+    first_response = requests.get("http://www.example.com").text
+    assert first_response == "first response"
+    second_response = requests.get("http://www.example.com").text
+    assert second_response == "second response"
+    # It just returns last response over and over again.
+    second_response = requests.get("http://www.example.com").text
+    assert second_response == "second response"
+    second_response = requests.get("http://www.example.com").text
+    assert second_response == "second response"
+    ##

earningscall-0.0.14/tests/test_sectors.py

@@ -0,0 +1,17 @@
+from earningscall.sectors import index_to_sector, index_to_industry, sector_to_index, industry_to_index
+
+
+def test_unknown_sector():
+    assert sector_to_index("Bad Sector") == -1
+
+
+def test_unknown_sector_index():
+    assert index_to_sector(-1) == "Unknown"
+
+
+def test_unknown_industry():
+    assert industry_to_index("Bad Industry") == -1
+
+
+def test_unknown_industry_index():
+    assert index_to_industry(-1) == "Unknown"

{earningscall-0.0.13 → earningscall-0.0.14}/tests/test_symbols.py

@@ -1,6 +1,7 @@
+import pytest
 import responses
 
-from earningscall.api import API_BASE
+from earningscall.api import API_BASE, purge_cache
 from earningscall.symbols import Symbols, CompanyInfo
 from earningscall.utils import data_path
 
@@ -8,6 +9,7 @@ from earningscall.utils import data_path
 @responses.activate
 def test_load_symbols_txt_v2():
     ##
+    purge_cache()
     responses.patch(API_BASE)
     responses._add_from_file(file_path=data_path("symbols-v2.yaml"))
     ##
@@ -21,10 +23,39 @@ def test_load_symbols_txt_v2():
     assert _symbol.industry == "Consumer Electronics"
     assert len(responses.calls) == 1
     assert responses.calls[0].request.url == "https://v2.api.earningscall.biz/symbols-v2.txt?apikey=demo"
+    ##
+    symbols.remove_exchange_symbol("NASDAQ_AAPL")
+    with pytest.raises(KeyError):
+        symbols.get_exchange_symbol("NASDAQ_AAPL")
+
+
+@responses.activate
+def test_load_symbols_txt_v2_missing_edge_cases():
+    ##
+    purge_cache()
+    responses.patch(API_BASE)
+    responses._add_from_file(file_path=data_path("symbols-v2-missing-edge-cases.yaml"))
+    ##
+    symbols = Symbols.load_txt_v2()
+    ##
+    assert len(symbols) == 4
+    _symbol = symbols.get_exchange_symbol("UNKNOWN_A")
+    assert _symbol.name == "Agilent Technologies, Inc."
+    assert _symbol.exchange == "UNKNOWN"
+    assert _symbol.sector == "Unknown"
+    assert _symbol.industry == "Unknown"
+    _symbol = symbols.get_exchange_symbol("NASDAQ_AACG")
+    assert _symbol.name == "ATA Creativity Global"
+    assert _symbol.exchange == "NASDAQ"
+    assert _symbol.sector == "Consumer Defensive"
+    assert _symbol.industry == "Education & Training Services"
+    assert len(responses.calls) == 1
+    assert responses.calls[0].request.url == "https://v2.api.earningscall.biz/symbols-v2.txt?apikey=demo"
 
 
 def test_symbols_serialization_to_text_v2():
     ##
+    purge_cache()
     _symbols = Symbols()
     _symbols.add(
         CompanyInfo(
@@ -66,3 +97,24 @@ def test_symbols_serialization_to_text_v2():
     assert _deserialized_symbols.get_exchange_symbol("TSX_ACB").sector == "Technology"
     assert _deserialized_symbols.get_exchange_symbol("TSX_ACB").industry == "Electronic Gaming & Multimedia"
     assert _deserialized_symbols.get_exchange_symbol("NASDAQ_HITI").name == "High Tide Inc."
+
+
+def test_symbols_serialization_v1():
+    _symbols = Symbols()
+    _symbols.add(CompanyInfo(exchange="TSX", symbol="TLRY", name="Tilray, Inc", sector="Energy", industry="Uranium"))
+    _symbols.add(
+        CompanyInfo(exchange="TSX", symbol="ACB", name="Aurora Cannabis Inc.", sector="Energy", industry="Uranium")
+    )
+    _symbols.add(
+        CompanyInfo(exchange="NASDAQ", symbol="HITI", name="High Tide Inc.", sector="Energy", industry="Uranium")
+    )
+    ##
+    result = _symbols.to_json()
+    ##
+    _deserialized_symbols = Symbols.from_json(result)
+    assert len(_deserialized_symbols) == 3
+    assert _deserialized_symbols.get_exchange_symbol("TSX_TLRY").name == "Tilray, Inc"
+    assert _deserialized_symbols.get_exchange_symbol("TSX_TLRY").sector == "Energy"
+    assert _deserialized_symbols.get_exchange_symbol("TSX_TLRY").industry == "Uranium"
+    assert _deserialized_symbols.get_exchange_symbol("TSX_ACB").name == "Aurora Cannabis Inc."
+    assert _deserialized_symbols.get_exchange_symbol("NASDAQ_HITI").name == "High Tide Inc."

earningscall-0.0.14/tests/test_utils.py

@@ -0,0 +1,13 @@
+from earningscall.utils import configure_sane_logging, enable_debug_logs, project_file_path
+
+
+def test_project_file_path_tests_dir():
+    project_file_path("tests", None)
+
+
+def test_enable_debug_logs():
+    enable_debug_logs()
+
+
+def test_configure_sane_logging():
+    configure_sane_logging()

earningscall-0.0.13/TODO.md

@@ -1,9 +0,0 @@
-# A list of things left to do for this project
-
-* Cache symbols on disk, to avoid redundant network calls
-
-
-
-# Considerations
-
-* Consider implementing @dataclass and @dataclass_json from scratch to avoid third-party dependency