earningscall 0.0.17__tar.gz → 0.0.18__tar.gz

{earningscall-0.0.17 → earningscall-0.0.18}/.gitignore

@@ -32,6 +32,7 @@ tasks.xml
 /build
 /sc.egg-info
 /packages
+/audio_files
 
 # Root files
 /.coverage*

earningscall-0.0.18/.python-version

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

earningscall-0.0.18/CHANGELOG.md

@@ -0,0 +1,22 @@
+## Release `0.0.18` - 2024-10-01
+
+* Add Download Audio File Feature: add `download_audio_file` function to the `Company` class.
+* Add "LSE" to the list of exchanges.
+
+## Release `0.0.17` - 2024-08-04
+
+* Remove apikey from the ignored parameters list.
+
+When `apikey=demo`, the API will return different results.  If we change
+apikey to some other value, then the old result from when `apikey=demo`
+would be returned.  This is incorrect.
+
+## Release `0.0.16` - 2024-06-12
+* Bump version number.
+
+## Release `0.0.15` - 2024-06-12
+* Remove `dataclasses` as a project dependency.  It is built directly into Python.
+
+## Release `0.0.14` - 2024-06-08
+* Add caching to improve client performance.
+* Add `company_info` attribute in `Company` class.

{earningscall-0.0.17 → earningscall-0.0.18}/DEVELOPMENT.md

@@ -1,7 +1,12 @@
 # Development
 
-First, install Hatch.  See the Hatch [installation instructions](https://hatch.pypa.io/latest/install/).
+First, install Hatch plus other build dependencies.  See the Hatch [installation instructions](https://hatch.pypa.io/latest/install/).
 
+My preferred way to install it is to use `pip`:
+
+```shell
+pip install hatch coverage black
+```
 
 ## Run Build
 
@@ -9,7 +14,6 @@ First, install Hatch.  See the Hatch [installation instructions](https://hatch.p
 hatch build
 ```
 
-
 ### Running Unit Tests
 
 ```shell

{earningscall-0.0.17 → earningscall-0.0.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: earningscall
-Version: 0.0.17
+Version: 0.0.18
 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

{earningscall-0.0.17 → earningscall-0.0.18}/TODO.md

@@ -3,7 +3,6 @@
 
 * 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

{earningscall-0.0.17 → earningscall-0.0.18}/earningscall/api.py

@@ -46,7 +46,22 @@ def purge_cache():
     return cache_session().cache.clear()
 
 
-def do_get(path: str, use_cache: bool = False, **kwargs):
+def do_get(
+    path: str,
+    use_cache: bool = False,
+    **kwargs,
+) -> requests.Response:
+    """
+    Do a GET request to the API.
+
+    Args:
+        path (str): The path to request.
+        use_cache (bool): Whether to use the cache.
+        **kwargs: Additional arguments to pass to the request.
+
+    Returns:
+        requests.Response: The response from the API.
+    """
     params = {
         **api_key_param(),
         **kwargs.get("params", {}),
@@ -56,7 +71,11 @@ def do_get(path: str, use_cache: bool = False, **kwargs):
     if use_cache and earningscall.enable_requests_cache:
         return cache_session().get(url, params=params)
     else:
-        return requests.get(url, params=params)
+        return requests.get(
+            url,
+            params=params,
+            stream=kwargs.get("stream"),
+        )
 
 
 def get_events(exchange: str, symbol: str):
@@ -72,8 +91,25 @@ def get_events(exchange: str, symbol: str):
     return response.json()
 
 
-def get_transcript(exchange: str, symbol: str, year: int, quarter: int) -> Optional[str]:
-
+def get_transcript(
+    exchange: str,
+    symbol: str,
+    year: int,
+    quarter: int,
+    level: Optional[int] = None,
+) -> Optional[str]:
+    """
+    Get the transcript for a given exchange, symbol, year, and quarter.
+
+    Args:
+        exchange (str): The exchange to get the transcript for.
+        symbol (str): The symbol to get the transcript for.
+        year (int): The year to get the transcript for.
+        quarter (int): The quarter to get the transcript for.
+
+    Returns:
+        Optional[str]: The transcript for the given exchange, symbol, year, and quarter.
+    """
     log.debug(f"get_transcript year: {year} quarter: {quarter}")
     params = {
         **api_key_param(),
@@ -81,6 +117,7 @@ def get_transcript(exchange: str, symbol: str, year: int, quarter: int) -> Optio
         "symbol": symbol,
         "year": str(year),
         "quarter": str(quarter),
+        "level": str(level or 1),
     }
     response = do_get("transcript", params=params)
     if response.status_code != 200:
@@ -102,3 +139,36 @@ def get_sp500_companies_txt_file():
     if response.status_code != 200:
         return None
     return response.text
+
+
+def download_audio_file(
+    exchange: str,
+    symbol: str,
+    year: int,
+    quarter: int,
+    file_name: Optional[str] = None,
+) -> Optional[str]:
+    """
+    Get the audio for a given exchange, symbol, year, and quarter.
+
+    Args:
+        exchange (str): The exchange to get the audio for.
+        symbol (str): The symbol to get the audio for.
+        year (int): The year to get the audio for.
+        quarter (int): The quarter to get the audio for.
+        filename (Optional[str]): The filename to save the audio to.
+    """
+    params = {
+        **api_key_param(),
+        "exchange": exchange,
+        "symbol": symbol,
+        "year": str(year),
+        "quarter": str(quarter),
+    }
+    local_filename = file_name or f"{exchange}_{symbol}_{year}_{quarter}.mp3"
+    with do_get("audio", params=params, stream=True) as response:
+        response.raise_for_status()
+        with open(local_filename, "wb") as f:
+            for chunk in response.iter_content(chunk_size=8192):
+                f.write(chunk)
+    return local_filename

earningscall-0.0.18/earningscall/company.py

@@ -0,0 +1,110 @@
+import logging
+from typing import Optional, List
+
+from earningscall import api
+from earningscall.event import EarningsEvent
+from earningscall.symbols import CompanyInfo
+from earningscall.transcript import Transcript
+
+log = logging.getLogger(__file__)
+
+
+class Company:
+
+    company_info: CompanyInfo
+    name: Optional[str]
+    _events: Optional[List[EarningsEvent]]
+
+    def __init__(self, company_info: CompanyInfo):
+        if not company_info:
+            raise ValueError("company_info must be present.")
+        self.company_info = company_info
+        self.name = company_info.name
+        self._events = None
+
+    def __str__(self):
+        return str(self.name)
+
+    def _get_events(self) -> List[EarningsEvent]:
+        if not self.company_info.exchange or not self.company_info.symbol:
+            return []
+        raw_response = api.get_events(self.company_info.exchange, self.company_info.symbol)
+        if not raw_response:
+            return []
+        return [EarningsEvent.from_dict(event) for event in raw_response["events"]]  # type: ignore
+
+    def events(self) -> List[EarningsEvent]:
+        if not self._events:
+            self._events = self._get_events()
+        return self._events
+
+    def get_transcript(
+        self,
+        year: Optional[int] = None,
+        quarter: Optional[int] = None,
+        event: Optional[EarningsEvent] = None,
+    ) -> Optional[Transcript]:
+        """
+        Get the transcript for a given year and quarter.
+
+        Args:
+            year (Optional[int]): The year to get the transcript for.
+            quarter (Optional[int]): The quarter to get the transcript for.
+            event (Optional[EarningsEvent]): The event to get the transcript for.
+
+        Returns:
+            Optional[Transcript]: The transcript for the given year and quarter.
+        """
+        if not self.company_info.exchange or not self.company_info.symbol:
+            return None
+        if (not year or not quarter) and event:
+            year = event.year
+            quarter = event.quarter
+        if (not year or not quarter) and not event:
+            raise ValueError("Must specify either event or year and quarter")
+        resp = api.get_transcript(
+            self.company_info.exchange,
+            self.company_info.symbol,
+            year,  # type: ignore
+            quarter,  # type: ignore
+            level=None,  # TODO: Pass level to API
+        )
+        # TODO: Parse Advanced transcript data
+        if not resp:
+            return None
+        return Transcript.from_dict(resp)  # type: ignore
+
+    def download_audio_file(
+        self,
+        year: Optional[int] = None,
+        quarter: Optional[int] = None,
+        event: Optional[EarningsEvent] = None,
+        file_name: Optional[str] = None,
+    ) -> Optional[str]:
+        """
+        Download the audio file for a given year and quarter.
+
+        Args:
+            year (Optional[int]): The year to get the audio for.
+            quarter (Optional[int]): The quarter to get the audio for.
+            event (Optional[EarningsEvent]): The event to get the audio for.
+            file_name (Optional[str]): The file name to save the audio to.
+
+        Returns:
+            Optional[str]: The audio for the given year and quarter.
+        """
+        if not self.company_info.exchange or not self.company_info.symbol:
+            return None
+        if (not year or not quarter) and event:
+            year = event.year
+            quarter = event.quarter
+        if (not year or not quarter) and not event:
+            raise ValueError("Must specify either event or year and quarter")
+        resp = api.download_audio_file(
+            exchange=self.company_info.exchange,
+            symbol=self.company_info.symbol,
+            year=year,  # type: ignore
+            quarter=quarter,  # type: ignore
+            file_name=file_name,
+        )
+        return resp

{earningscall-0.0.17 → earningscall-0.0.18}/earningscall/symbols.py

@@ -8,7 +8,7 @@ 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"]
+EXCHANGES_IN_ORDER = ["NYSE", "NASDAQ", "AMEX", "TSX", "TSXV", "OTC", "LSE"]
 
 log = logging.getLogger(__file__)
 

{earningscall-0.0.17 → earningscall-0.0.18}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "earningscall"
-version = "0.0.17"
+version = "0.0.18"
 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 = [

earningscall-0.0.18/scripts/download_audio_files.py

@@ -0,0 +1,28 @@
+import os
+from earningscall import get_company
+
+
+directory = "audio_files"
+os.makedirs(directory, exist_ok=True)
+
+
+def download_audio_files(company):
+    print(f"Downloading all audio files for: {company}..")
+    for event in company.events():
+        file_name = os.path.join(
+            directory,
+            f"{company.company_info.exchange}_{company.company_info.symbol}_{event.year}_Q{event.quarter}.mp3",
+        )
+        if os.path.exists(file_name):
+            print(f"* {company.company_info.symbol} Q{event.quarter} {event.year} -- already downloaded")
+        else:
+            print(f"* Downloading audio file for {company.company_info.symbol} Q{event.quarter} {event.year}...")
+            audio_file = company.download_audio_file(event=event, file_name=file_name)
+            if audio_file:
+                print(f" Downloaded audio file: \"{audio_file}\"")
+            else:
+                print(f" No audio file found for {company.company_info.symbol} Q{event.quarter} {event.year}")
+
+
+company = get_company("aapl")  # Lookup Apple, Inc by its ticker symbol, "AAPL"
+download_audio_files(company)

earningscall-0.0.18/scripts/download_sp500_audio_files.py

@@ -0,0 +1,30 @@
+import os
+from earningscall import get_sp500_companies
+
+# TODO: Set your API key here:
+# earningscall.api_key = "YOUR SECRET API KEY GOES HERE"
+
+directory = "audio_files"
+os.makedirs(directory, exist_ok=True)
+
+
+def download_audio_files(company):
+    print(f"Downloading all audio files for: {company}..")
+    for event in company.events():
+        file_name = os.path.join(
+            directory,
+            f"{company.company_info.exchange}_{company.company_info.symbol}_{event.year}_Q{event.quarter}.mp3",
+        )
+        if os.path.exists(file_name):
+            print(f"* {company.company_info.symbol} Q{event.quarter} {event.year} -- already downloaded")
+        else:
+            print(f"* Downloading audio file for {company.company_info.symbol} Q{event.quarter} {event.year}...")
+            audio_file = company.download_audio_file(event=event, file_name=file_name)
+            if audio_file:
+                print(f" Downloaded audio file: \"{audio_file}\"")
+            else:
+                print(f" No audio file found for {company.company_info.symbol} Q{event.quarter} {event.year}")
+
+
+for company in get_sp500_companies():
+    download_audio_files(company)

{earningscall-0.0.17 → earningscall-0.0.18}/tests/data/demo-symbols-v2-alpha.yaml

@@ -716,4 +716,4 @@ responses:
     content_type: text/plain
     method: GET
     status: 200
-    url: https://v2.api.earningscall.biz/transcript?apikey=demo&exchange=NASDAQ&symbol=AAPL&year=2022&quarter=1
+    url: https://v2.api.earningscall.biz/transcript?apikey=demo&exchange=NASDAQ&symbol=AAPL&year=2022&quarter=1&level=1