earningscall 1.0.2__tar.gz → 1.1.1__tar.gz

{earningscall-1.0.2 → earningscall-1.1.1}/.gitignore

@@ -36,4 +36,7 @@ tasks.xml
 
 # Root files
 /.coverage*
-/.mypy_cache/
+/.mypy_cache/
+
+# Downloaded Data from Scripts
+/data

earningscall-1.1.1/.python-version

@@ -0,0 +1 @@
+3.12.8

{earningscall-1.0.2 → earningscall-1.1.1}/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## Release `1.1.1` - 2025-01-26
+
+* Modify default retry strategy to use 1s base delay and 10 max attempts (necessary for starter plan).
+* Check for HTTP 401 Unauthorized status code from server and raise a helpful error message to the user.
+* Update documentation and example scripts to reflect new retry configuration
+
+## Release `1.1.0` - 2025-01-26
+
+* Add backoff and retry logic to all API calls.
+* Add tests for rate limiting.
+
 ## Release `1.0.2` - 2024-12-24
 
 * Add STO exchange to the list of exchanges.

{earningscall-1.0.2 → earningscall-1.1.1}/DEVELOPMENT.md

@@ -13,7 +13,7 @@ First, install Hatch plus other build dependencies.  See the Hatch [installation
 My preferred way to install it is to use `pip`:
 
 ```shell
-pip install hatch coverage black
+pip install hatch hatch-containers coverage black responses
 ```
 
 ## Run Build
@@ -41,6 +41,18 @@ Or, generate HTML report locally:
 coverage html
 ```
 
+### Run Container Tests
+
+The container tests are run in GitHub Actions.  Normally, you don't need to run them locally.
+
+The container tests run all unit tests in a containerized environment.
+
+Each environment is a different Python version.
+
+```shell
+hatch run all:test
+```
+
 ### Run Linter
 
 ```shell

{earningscall-1.0.2 → earningscall-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: earningscall
-Version: 1.0.2
+Version: 1.1.1
 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
@@ -32,7 +32,7 @@ License: MIT License
         SOFTWARE.
 License-File: LICENSE
 Keywords: earning call app,earnings call,earnings call api,earnings call app,earnings call transcript api,earnings call transcripts,earnings call transcripts api,earnings calls,earnings transcript api,listen to earnings calls,transcripts,where to listen to earnings calls
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
@@ -41,6 +41,7 @@ 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: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Requires-Python: >=3.8
@@ -55,6 +56,7 @@ Description-Content-Type: text/markdown
 [![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/)
+[![GitHub Stars](https://img.shields.io/github/stars/EarningsCall/earningscall-python.svg?style=social&label=Star)](https://github.com/EarningsCall/earningscall-python)
 
 [![Python](https://img.shields.io/badge/Python-14354C?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)
 
@@ -310,3 +312,60 @@ import earningscall
 
 earningscall.enable_requests_cache = False
 ```
+
+### Retry Strategy
+
+The library implements a flexible retry strategy to handle rate limiting and HTTP 5xx errors effectively. By default, it retries with increasing delays: 3 seconds, 6 seconds, 12 seconds, 24 seconds, and finally 48 seconds. If the request fails after five attempts, the library raises an exception.
+
+#### Customizing the Retry Strategy
+
+Depending on your specific requirements, you can adjust the retry strategy. For latency-sensitive applications, consider reducing the base delay and limiting the number of retry attempts. Conversely, for plans with lower rate limits, such as the "Starter" plan, a higher base delay with more retry attempts can improve reliability. For higher-rate-limit plans, such as "Enterprise," a shorter delay and fewer attempts may be more appropriate.
+
+To customize the retry behavior, set the `retry_strategy` variable with the desired parameters:
+
+- **strategy**: "exponential" | "linear" — defines the type of retry strategy (default is "exponential").
+- **base_delay**: float (in seconds) — specifies the delay between retries (default is 1 seconds).
+- **max_attempts**: int — sets the maximum number of total request attempts (default is 10).
+
+#### Default Retry Strategy
+
+Below is the default retry configuration:
+
+```python
+import earningscall
+
+earningscall.retry_strategy = {
+    "strategy": "exponential",
+    "base_delay": 1,
+    "max_attempts": 10,
+}
+```
+
+#### Disabling Retries
+
+To disable retries entirely and limit the request to a single attempt, set `max_attempts` to `1`:
+
+```python
+import earningscall
+
+earningscall.retry_strategy = {
+    "strategy": "exponential",
+    "base_delay": 1,
+    "max_attempts": 1,
+}
+```
+
+#### Linear Retry Strategy
+
+You can switch to a linear retry strategy by setting the `strategy` parameter to "linear":
+
+```python
+import earningscall
+
+earningscall.retry_strategy = {
+    "strategy": "linear",
+    "base_delay": 1,
+    "max_attempts": 3,
+}
+```
+

{earningscall-1.0.2 → earningscall-1.1.1}/README.md

@@ -4,6 +4,7 @@
 [![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/)
+[![GitHub Stars](https://img.shields.io/github/stars/EarningsCall/earningscall-python.svg?style=social&label=Star)](https://github.com/EarningsCall/earningscall-python)
 
 [![Python](https://img.shields.io/badge/Python-14354C?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)
 
@@ -259,3 +260,60 @@ import earningscall
 
 earningscall.enable_requests_cache = False
 ```
+
+### Retry Strategy
+
+The library implements a flexible retry strategy to handle rate limiting and HTTP 5xx errors effectively. By default, it retries with increasing delays: 3 seconds, 6 seconds, 12 seconds, 24 seconds, and finally 48 seconds. If the request fails after five attempts, the library raises an exception.
+
+#### Customizing the Retry Strategy
+
+Depending on your specific requirements, you can adjust the retry strategy. For latency-sensitive applications, consider reducing the base delay and limiting the number of retry attempts. Conversely, for plans with lower rate limits, such as the "Starter" plan, a higher base delay with more retry attempts can improve reliability. For higher-rate-limit plans, such as "Enterprise," a shorter delay and fewer attempts may be more appropriate.
+
+To customize the retry behavior, set the `retry_strategy` variable with the desired parameters:
+
+- **strategy**: "exponential" | "linear" — defines the type of retry strategy (default is "exponential").
+- **base_delay**: float (in seconds) — specifies the delay between retries (default is 1 seconds).
+- **max_attempts**: int — sets the maximum number of total request attempts (default is 10).
+
+#### Default Retry Strategy
+
+Below is the default retry configuration:
+
+```python
+import earningscall
+
+earningscall.retry_strategy = {
+    "strategy": "exponential",
+    "base_delay": 1,
+    "max_attempts": 10,
+}
+```
+
+#### Disabling Retries
+
+To disable retries entirely and limit the request to a single attempt, set `max_attempts` to `1`:
+
+```python
+import earningscall
+
+earningscall.retry_strategy = {
+    "strategy": "exponential",
+    "base_delay": 1,
+    "max_attempts": 1,
+}
+```
+
+#### Linear Retry Strategy
+
+You can switch to a linear retry strategy by setting the `strategy` parameter to "linear":
+
+```python
+import earningscall
+
+earningscall.retry_strategy = {
+    "strategy": "linear",
+    "base_delay": 1,
+    "max_attempts": 3,
+}
+```
+

{earningscall-1.0.2 → earningscall-1.1.1}/earningscall/__init__.py

@@ -1,9 +1,10 @@
-from typing import Optional
+from typing import Dict, Optional, Union
 
 from earningscall.exports import get_company, get_all_companies, get_sp500_companies
 from earningscall.symbols import Symbols, load_symbols
 
 api_key: Optional[str] = None
 enable_requests_cache: bool = True
+retry_strategy: Optional[Dict[str, Union[str, int, float]]] = None
 
 __all__ = ["get_company", "get_all_companies", "get_sp500_companies", "Symbols", "load_symbols"]

{earningscall-1.0.2 → earningscall-1.1.1}/earningscall/api.py

@@ -3,18 +3,25 @@ import platform
 import urllib.parse
 import logging
 import os
+import time
 from importlib.metadata import PackageNotFoundError
-from typing import Optional
+from typing import Dict, Optional, Union
 
 import requests
 from requests_cache import CachedSession
 
 import earningscall
+from earningscall.errors import InvalidApiKeyError
 
 log = logging.getLogger(__file__)
 
-DOMAIN = os.environ.get("ECALL_DOMAIN", "earningscall.biz")
+DOMAIN = os.environ.get("EARNINGSCALL_DOMAIN", "earningscall.biz")
 API_BASE = f"https://v2.api.{DOMAIN}"
+DEFAULT_RETRY_STRATEGY: Dict[str, Union[str, int, float]] = {
+    "strategy": "exponential",
+    "base_delay": 1,
+    "max_attempts": 10,
+}
 
 
 def get_api_key():
@@ -81,13 +88,27 @@ def get_headers():
     }
 
 
+def can_retry(response: requests.Response) -> bool:
+    if response.status_code == 429:
+        return True
+    # Check for 5XX errors
+    if response.status_code >= 500 and response.status_code < 600:
+        return True
+    return False
+
+
+def is_success(response: requests.Response) -> bool:
+    # TODO: Do we need to check for 2xx status codes?
+    return response.status_code == 200
+
+
 def do_get(
     path: str,
     use_cache: bool = False,
     **kwargs,
 ) -> requests.Response:
     """
-    Do a GET request to the API.
+    Do a GET request to the API with exponential backoff retry for rate limits.
 
     Args:
         path (str): The path to request.
@@ -105,15 +126,47 @@ def do_get(
     if log.isEnabledFor(logging.DEBUG):
         full_url = f"{url}?{urllib.parse.urlencode(params)}"
         log.debug(f"GET: {full_url}")
-    if use_cache and earningscall.enable_requests_cache:
-        return cache_session().get(url, params=params)
-    else:
-        return requests.get(
-            url,
-            params=params,
-            headers=get_headers(),
-            stream=kwargs.get("stream"),
-        )
+
+    retry_strategy = earningscall.retry_strategy or DEFAULT_RETRY_STRATEGY
+    delay = retry_strategy["base_delay"]
+    max_attempts = int(retry_strategy["max_attempts"])
+
+    for attempt in range(max_attempts):
+        if use_cache and earningscall.enable_requests_cache:
+            response = cache_session().get(url, params=params)
+        else:
+            response = requests.get(
+                url,
+                params=params,
+                headers=get_headers(),
+                stream=kwargs.get("stream"),
+            )
+
+        if is_success(response):
+            return response
+
+        if response.status_code == 401:
+            raise InvalidApiKeyError(
+                "Your API key is invalid. You can get your API key at: https://earningscall.biz/api-key"
+            )
+
+        if not can_retry(response):
+            return response
+
+        if attempt < max_attempts - 1:  # Don't sleep after the last attempt
+            if retry_strategy["strategy"] == "exponential":
+                wait_time = delay * (2**attempt)  # Exponential backoff: 1s -> 2s -> 4s -> 8s -> 16s -> 32s -> 64s
+            elif retry_strategy["strategy"] == "linear":
+                wait_time = delay * (attempt + 1)  # Linear backoff: 1s -> 2s -> 3s -> 4s -> 5s -> 6s -> 7s
+            else:
+                raise ValueError("Invalid retry strategy. Must be one of: 'exponential', 'linear'")
+            # TODO: Should we log a warning here?  Does the customer want to see this log?
+            log.warning(
+                f"Rate limited (429). Retrying in {wait_time} seconds... (Attempt {attempt + 1}/{max_attempts})"
+            )
+            time.sleep(wait_time)
+
+    return response  # Return the last response if all retries failed
 
 
 def get_events(exchange: str, symbol: str):

{earningscall-1.0.2 → earningscall-1.1.1}/earningscall/errors.py

@@ -22,3 +22,7 @@ class ClientError(BaseError):
 
 class InsufficientApiAccessError(ClientError):
     pass
+
+
+class InvalidApiKeyError(ClientError):
+    pass

{earningscall-1.0.2 → earningscall-1.1.1}/earningscall/symbols.py

@@ -8,7 +8,17 @@ from earningscall.errors import InsufficientApiAccessError
 from earningscall.sectors import sector_to_index, industry_to_index, index_to_sector, index_to_industry
 
 # WARNING: Add new indexes to the *END* of this list
-EXCHANGES_IN_ORDER = ["NYSE", "NASDAQ", "AMEX", "TSX", "TSXV", "OTC", "LSE", "CBOE", "STO"]
+EXCHANGES_IN_ORDER = [
+    "NYSE",
+    "NASDAQ",
+    "AMEX",
+    "TSX",
+    "TSXV",
+    "OTC",
+    "LSE",
+    "CBOE",
+    "STO",
+]
 
 log = logging.getLogger(__file__)
 

{earningscall-1.0.2 → earningscall-1.1.1}/pyproject.toml

@@ -1,54 +1,53 @@
 [project]
 name = "earningscall"
-version = "1.0.2"
+version = "1.1.1"
 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"},
-]
+authors = [{ name = "EarningsCall", email = "dev@earningscall.biz" }]
 requires-python = ">= 3.8"
 dependencies = [
-    "dataclasses-json>=0.6.4",
-    "requests>=2.30.0",
-    "requests-cache>=1.2.0",
+  "dataclasses-json>=0.6.4",
+  "requests>=2.30.0",
+  "requests-cache>=1.2.0",
 ]
 license = { file = "LICENSE" }
 keywords = [
-    "earnings calls",
-    "earnings call",
-    "earnings call api",
-    "earnings call transcripts",
-    "earnings call transcripts api",
-    "earnings call transcript api",
-    "earnings call app",
-    "earning call app",
-    "listen to earnings calls",
-    "where to listen to earnings calls",
-    "earnings transcript api",
-    "transcripts",
+  "earnings calls",
+  "earnings call",
+  "earnings call api",
+  "earnings call transcripts",
+  "earnings call transcripts api",
+  "earnings call transcript api",
+  "earnings call app",
+  "earning call app",
+  "listen to earnings calls",
+  "where to listen to earnings calls",
+  "earnings transcript api",
+  "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",
+  # How mature is this project? Common values are
+  #   3 - Alpha
+  #   4 - Beta
+  #   5 - Production/Stable
+  "Development Status :: 5 - Production/Stable",
+
+  # 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",
+  "Programming Language :: Python :: 3.13",
 ]
 
 [project.urls]
@@ -75,25 +74,20 @@ packages = ["earningscall"]
 path = "hatch_init/__about__.py"
 
 [tool.hatch.envs.default]
-dependencies = [
-    "pytest",
-    "pytest-cov",
-]
+dependencies = ["pytest", "pytest-cov", "responses"]
 [tool.hatch.envs.default.scripts]
 cov = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=hatch_init --cov=tests"
 no-cov = "cov --no-cov"
 
 [[tool.hatch.envs.test.matrix]]
-python = ["3.8", "3.9", "3.10", "3.11", "3.12"]
+python = ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
 
 
 [tool.hatch.build.targets.wheel.hooks.mypyc]
 enable-by-default = false
 dependencies = ["hatch-mypyc>=0.14.1"]
 require-runtime-dependencies = true
-mypy-args = [
-  "--no-warn-unused-ignores",
-]
+mypy-args = ["--no-warn-unused-ignores"]
 
 [tool.mypy]
 disallow_untyped_defs = false
@@ -121,10 +115,14 @@ ignore = [
   "FBT003",
   # Ignore checks for possible passwords
   # Ignore complexity
-  "C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915",
+  "C901",
+  "PLR0911",
+  "PLR0912",
+  "PLR0913",
+  "PLR0915",
   "PLC1901", # empty string comparisons
   "PLW2901", # `for` loop variable overwritten
-  "SIM114", # Combine `if` branches using logical `or` operator
+  "SIM114",  # Combine `if` branches using logical `or` operator
 ]
 unfixable = [
   # Don't touch unused imports
@@ -156,11 +154,7 @@ earningscall = ["earningscall"]
 tests = ["tests"]
 
 [tool.coverage.report]
-exclude_lines = [
-    "no cov",
-    "if __name__ == .__main__.:",
-    "if TYPE_CHECKING:",
-]
+exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]
 
 [tool.pytest.ini_options]
 log_level = "DEBUG"

{earningscall-1.0.2 → earningscall-1.1.1}/scripts/get_all_company_transcripts.py

@@ -1,7 +1,10 @@
+import earningscall  # noqa: F401
 from earningscall import get_company
 
+# earningscall.api_key = "YOUR API KEY HERE"
 
-company = get_company("aapl")  # Lookup Apple, Inc by its ticker symbol, "AAPL"
+
+company = get_company("AAPL")  # Lookup Apple, Inc by its ticker symbol, "AAPL"
 
 print(f"Getting all transcripts for: {company}..")
 

earningscall-1.1.1/scripts/get_all_sp500_transcript_texts.py

@@ -0,0 +1,44 @@
+from datetime import datetime
+import os
+
+import earningscall  # noqa: F401
+from earningscall import get_sp500_companies
+from earningscall.company import Company
+
+# TODO: Set your API key here:
+# earningscall.api_key = "YOUR SECRET API KEY GOES HERE"
+
+directory = "data/transcript_texts"
+os.makedirs(directory, exist_ok=True)
+
+
+def download_transcript_texts(company: Company):
+    print(f"Downloading all transcript texts for: {company}..")
+    for event in company.events():
+        if datetime.now().timestamp() < event.conference_date.timestamp():
+            print(
+                f"* {company.company_info.symbol} Q{event.quarter} {event.year} -- skipping, conference date in the future"
+            )
+            continue
+        file_name = os.path.join(
+            directory,
+            f"{company.company_info.exchange}_{company.company_info.symbol}_{event.year}_Q{event.quarter}.text",
+        )
+        if os.path.exists(file_name):
+            print(f"* {company.company_info.symbol} Q{event.quarter} {event.year} -- already downloaded")
+        else:
+            print(f"* Downloading transcript text for {company.company_info.symbol} Q{event.quarter} {event.year}...")
+            transcript = company.get_transcript(event=event)
+            if transcript:
+                # Save transcript text to file
+                with open(file_name, "w") as fd:
+                    fd.write(transcript.text)
+                print(
+                    f" Downloaded transcript text for {company.company_info.symbol} Q{event.quarter} {event.year} to: {file_name}"
+                )
+            else:
+                print(f" No transcript text found for {company.company_info.symbol} Q{event.quarter} {event.year}")
+
+
+for company in get_sp500_companies():
+    download_transcript_texts(company)

{earningscall-1.0.2 → earningscall-1.1.1}/scripts/get_single_transcript.py

@@ -4,10 +4,9 @@ from earningscall import get_company
 
 
 # TODO: Set your API key here:
-# earningscall.api_key = "YOUR SECRET API KEY GOES HERE"
+# earningscall.api_key = "YOUR API KEY HERE"
 
-
-company = get_company("aapl")
+company = get_company("AAPL")
 
 transcript = company.get_transcript(year=2021, quarter=3, level=2)
 

{earningscall-1.0.2 → earningscall-1.1.1}/tests/test_download_audio_files.py

@@ -1,11 +1,10 @@
 import os
 
-from requests import HTTPError
-
-import earningscall
 import pytest
 import responses
+from requests import HTTPError
 
+import earningscall
 from earningscall import get_company
 from earningscall.api import purge_cache
 from earningscall.company import Company
@@ -28,6 +27,11 @@ def run_before_and_after_tests():
     """Fixture to execute asserts before and after a test is run"""
     # Setup: fill with any logic you want
     earningscall.api_key = None
+    earningscall.retry_strategy = {
+        "strategy": "exponential",
+        "base_delay": 0.001,
+        "max_attempts": 3,
+    }
     purge_cache()
     clear_symbols()
     yield  # this is where the testing happens

{earningscall-1.0.2 → earningscall-1.1.1}/tests/test_get_transcript.py

@@ -1,13 +1,14 @@
-from requests import HTTPError
+import json
 
-import earningscall
 import pytest
 import responses
+from requests import HTTPError
 
+import earningscall
 from earningscall import get_company
 from earningscall.api import purge_cache
 from earningscall.company import Company
-from earningscall.errors import InsufficientApiAccessError
+from earningscall.errors import InsufficientApiAccessError, InvalidApiKeyError
 from earningscall.event import EarningsEvent
 from earningscall.symbols import clear_symbols, CompanyInfo
 from earningscall.transcript import Transcript
@@ -27,6 +28,11 @@ def run_before_and_after_tests():
     """Fixture to execute asserts before and after a test is run"""
     # Setup: fill with any logic you want
     earningscall.api_key = None
+    earningscall.retry_strategy = {
+        "strategy": "exponential",
+        "base_delay": 0.01,
+        "max_attempts": 3,
+    }
     purge_cache()
     clear_symbols()
     yield  # this is where the testing happens
@@ -276,6 +282,110 @@ def test_data_class_for_transcript():
     assert transcript.speaker_name_map_v2["spk01"].title == "CEO"
 
 
+@responses.activate
+def test_get_transcript_with_rate_limit_backoff_and_retry():
+    ##
+    responses._add_from_file(file_path=data_path("symbols-v2.yaml"))
+    # First response
+    responses.add(
+        responses.GET,
+        "https://v2.api.earningscall.biz/transcript?apikey=demo&exchange=NASDAQ&symbol=AAPL&year=2023&quarter=1&level=1",
+        body=json.dumps({"error": "Rate limit exceeded"}),
+        status=429,
+    )
+    # Second response
+    responses.add(
+        responses.GET,
+        "https://v2.api.earningscall.biz/transcript?apikey=demo&exchange=NASDAQ&symbol=AAPL&year=2023&quarter=1&level=1",
+        body=json.dumps({"text": "Hello, world!"}),
+        status=200,
+    )
+    ##
+    company = get_company("aapl")
+    ##
+    transcript = company.get_transcript(year=2023, quarter=1, level=1)
+    # ##
+    assert transcript.text == "Hello, world!"
+
+
+@responses.activate
+def test_get_transcript_fails_all_attempts():
+    ##
+    responses._add_from_file(file_path=data_path("symbols-v2.yaml"))
+    # Always throttle the caller
+    responses.add(
+        responses.GET,
+        "https://v2.api.earningscall.biz/transcript?apikey=demo&exchange=NASDAQ&symbol=AAPL&year=2023&quarter=1&level=1",
+        body=json.dumps({"error": "Rate limit exceeded"}),
+        status=429,
+    )
+    ##
+    company = get_company("aapl")
+    ##
+    with pytest.raises(HTTPError):
+        company.get_transcript(year=2023, quarter=1, level=1)
+
+
+@responses.activate
+def test_get_transcript_fails_all_attempts_linear_retry_strategy():
+    earningscall.retry_strategy = {
+        "strategy": "linear",
+        "base_delay": 0.01,
+        "max_attempts": 3,
+    }
+    ##
+    responses._add_from_file(file_path=data_path("symbols-v2.yaml"))
+    # Always throttle the caller
+    responses.add(
+        responses.GET,
+        "https://v2.api.earningscall.biz/transcript?apikey=demo&exchange=NASDAQ&symbol=AAPL&year=2023&quarter=1&level=1",
+        body=json.dumps({"error": "Rate limit exceeded"}),
+        status=429,
+    )
+    ##
+    company = get_company("aapl")
+    ##
+    with pytest.raises(HTTPError):
+        company.get_transcript(year=2023, quarter=1, level=1)
+
+
+@responses.activate
+def test_get_transcript_fails_all_attempts_invalid_retry_strategy():
+    earningscall.retry_strategy = {
+        "strategy": "invalid",
+        "base_delay": 0.01,
+        "max_attempts": 3,
+    }
+    ##
+    responses._add_from_file(file_path=data_path("symbols-v2.yaml"))
+    # Always throttle the caller
+    responses.add(
+        responses.GET,
+        "https://v2.api.earningscall.biz/transcript?apikey=demo&exchange=NASDAQ&symbol=AAPL&year=2023&quarter=1&level=1",
+        body=json.dumps({"error": "Rate limit exceeded"}),
+        status=429,
+    )
+    ##
+    company = get_company("aapl")
+    ##
+    with pytest.raises(ValueError):
+        company.get_transcript(year=2023, quarter=1, level=1)
+
+
+@responses.activate
+def test_get_company_fails_not_authorized():
+    # Always throttle the caller
+    responses.add(
+        responses.GET,
+        "https://v2.api.earningscall.biz/symbols-v2.txt",
+        body=json.dumps({"error": "Not authorized"}),
+        status=401,
+    )
+    ##
+    with pytest.raises(InvalidApiKeyError):
+        get_company("aapl")
+
+
 # Uncomment and run following code to generate demo-symbols-v2.yaml file
 #
 # import requests

{earningscall-1.0.2 → earningscall-1.1.1}/tests/test_symbols.py

@@ -1,7 +1,7 @@
-import earningscall
 import pytest
 import responses
 
+import earningscall
 from earningscall.api import API_BASE, purge_cache
 from earningscall.symbols import Symbols, CompanyInfo
 from earningscall.utils import data_path
@@ -127,3 +127,17 @@ def test_symbols_serialization_v1():
     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."
+
+
+def test_exchanges_in_order():
+    assert earningscall.symbols.EXCHANGES_IN_ORDER == [
+        "NYSE",
+        "NASDAQ",
+        "AMEX",
+        "TSX",
+        "TSXV",
+        "OTC",
+        "LSE",
+        "CBOE",
+        "STO",
+    ]

earningscall-1.0.2/.python-version

@@ -1 +0,0 @@
-3.12.6