earningscall 0.0.17__py3-none-any.whl → 0.0.18__py3-none-any.whl

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/company.py

@@ -39,9 +39,22 @@ class Company:
         return self._events
 
     def get_transcript(
-        self, year: Optional[int] = None, quarter: Optional[int] = None, event: Optional[EarningsEvent] = None
+        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:
@@ -49,7 +62,49 @@ class Company:
             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, quarter)  # type: ignore
+        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/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.dist-info → earningscall-0.0.18.dist-info}/METADATA

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

@@ -1,14 +1,14 @@
 earningscall/__init__.py,sha256=0mANmPlE7LEWtOGzV2cmmlPfBIWBWlWRDkyqPHJ1jm8,333
-earningscall/api.py,sha256=F_1h8ib7xCK0r8wMtp79D8BQgiusYmfsaRrAaPF9eic,2488
-earningscall/company.py,sha256=ZNF75htXg37oXtNzwrHH8DoTdyFJ3PBB9qSNBp_vo8c,1943
+earningscall/api.py,sha256=jTkPI-RVOOv4fiQ6RNpTuc-ef210t9zsO2qfF2lTMqw,4463
+earningscall/company.py,sha256=L0XZc1d4RzL_GP_p7vt8NmXDKl1C0vz18UkSVsfjxK4,3894
 earningscall/errors.py,sha256=EA-d6qIYgQs9csp8JptQiAaYoM0M9HhCGJgKA9GAWPg,440
 earningscall/event.py,sha256=Jf7KPvpeaF9KkeHe46LbL_HIYLXkyHrs3psq-ZY-bkI,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/symbols.py,sha256=39tL7oP1HT8BturwKW7mgS33dX2Y_X8cw5GKK0aV02k,6354
 earningscall/transcript.py,sha256=vuI0FOSaWDGKYaUxq1i6cnBZQJ2TAuARAWAhHlfuNRc,329
 earningscall/utils.py,sha256=Qx8KhlumUdzyBSZRKMS6vpWlb8MGZpLKA4OffJaMdCE,1032
-earningscall-0.0.17.dist-info/METADATA,sha256=Ph8kEPLaoGnl3KEEXDqN_oU1i21-vrnG6wG5Pz7V-CU,7177
-earningscall-0.0.17.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-earningscall-0.0.17.dist-info/licenses/LICENSE,sha256=ktEB_UcRMg2cQlX9wiDs544xWncWizwS9mEZuGsCLrM,1069
-earningscall-0.0.17.dist-info/RECORD,,
+earningscall-0.0.18.dist-info/METADATA,sha256=r1Kas9LcEs00qZLL1e7AC3KGicw9FyFw9S1j87DFBhM,7177
+earningscall-0.0.18.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+earningscall-0.0.18.dist-info/licenses/LICENSE,sha256=ktEB_UcRMg2cQlX9wiDs544xWncWizwS9mEZuGsCLrM,1069
+earningscall-0.0.18.dist-info/RECORD,,