earningscall 0.0.21__tar.gz → 0.0.23__tar.gz

{earningscall-0.0.21 → earningscall-0.0.23}/CHANGELOG.md

@@ -1,3 +1,13 @@
+## Release `0.0.23` - 2024-11-24
+
+* Allow `None` for optional fields in SpeakerInfo data structure.
+* Update logging format for API calls.
+* Update logging level to DEBUG in unit tests.
+
+## Release `0.0.22` - 2024-10-07
+
+* Add **experimental feature**: Speaker Names and Titles
+
 ## Release `0.0.21` - 2024-10-07
 
 * Bump version for PyPI release: updated README docs.

{earningscall-0.0.21 → earningscall-0.0.23}/DEVELOPMENT.md

@@ -1,5 +1,13 @@
 # Development
 
+The instructions on this page are meant for library contributors.
+If you are interested in contributing to this project, read on.
+Otherwise, if you are simply wanting to get EarningsCalls Transcripts or Audio Files,
+please read the [README page](README.md) to get started.
+
+
+## Getting Started
+
 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`:

{earningscall-0.0.21 → earningscall-0.0.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: earningscall
-Version: 0.0.21
+Version: 0.0.23
 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
@@ -30,7 +30,6 @@ License: MIT License
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         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: Intended Audience :: Developers
@@ -95,6 +94,8 @@ Apple Inc. Q3 2021 Transcript Text: "Good day, and welcome to the Apple Q3 FY 20
 
 
 ```python
+from datetime import datetime
+
 from earningscall import get_company
 
 company = get_company("aapl")  # Lookup Apple, Inc by its ticker symbol, "AAPL"
@@ -102,6 +103,9 @@ company = get_company("aapl")  # Lookup Apple, Inc by its ticker symbol, "AAPL"
 print(f"Getting all transcripts for: {company}..")
 # Retrieve all earnings conference call events for a company, and iterate through each one
 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
     transcript = company.get_transcript(event=event)  # Fetch the earnings call transcript for this event
     print(f"* Q{event.quarter} {event.year}")
     if transcript:
@@ -153,6 +157,38 @@ Speaker: spk11
 Text: Good day, and welcome to the Apple Q3 FY 2021 Earnings Conference Call. Today's call is being recorded. At this time, for opening remarks and introductions, I would like to turn the call over to Tejas Ghala, Director, Investor Relations and Corporate Finance. Please go ahead.
 ```
 
+
+## Get Text by Speaker with Speaker Name and Title
+
+NOTE: This is a new experimental feature.  It includes Speaker Names and Titles.
+
+```python
+from earningscall import get_company
+
+company = get_company("aapl")  # Lookup Apple, Inc by its ticker symbol, "AAPL"
+
+transcript = company.get_transcript(year=2021, quarter=3, level=2)
+
+speaker = transcript.speakers[1]  # Get second speaker
+speaker_label = speaker.speaker_info.name
+text = speaker.text
+print("Speaker:")
+print(f"  Name: {speaker.speaker_info.name}")
+print(f"  Title: {speaker.speaker_info.title}")
+print()
+print(f"Text: {text}")
+```
+
+Output
+
+```text
+Speaker:
+  Name: Tejas Ghala
+  Title: Director, Investor Relations and Corporate Finance
+
+Text: Thank you. Good afternoon, and thank you for joining us. Speaking first today is Apple CEO Tim Cook, and he'll be followed by CFO Luca Maestri. After that, we'll open the call to questions from analysts. Please note that some of the information you'll hear during our discussion today will consist of forward-looking statements, including without limitation, those regarding revenue, gross margin, operating expenses, other income and expenses, taxes, capital allocation, and future business outlook, including the potential impact of COVID-19 on the company's business and results of operations. These statements involve risks and uncertainties that may cause actual results or trends to differ materially from our forecast. For more information, please refer to the risk factors discussed in Apple's most recently filed annual report on Form 10-K and the Form 8-K filed with the SEC today, along with the associated press release. Apple assumes no obligation to update any forward-looking statements or information which speak as of their respective dates. I'd like to now turn the call over to Tim for introductory remarks.
+```
+
 ## Get Word-Level Timestamps
 
 If you want to get the word-level timestamps, you can do so by setting the `level` parameter to `3`.

{earningscall-0.0.21 → earningscall-0.0.23}/README.md

@@ -44,6 +44,8 @@ Apple Inc. Q3 2021 Transcript Text: "Good day, and welcome to the Apple Q3 FY 20
 
 
 ```python
+from datetime import datetime
+
 from earningscall import get_company
 
 company = get_company("aapl")  # Lookup Apple, Inc by its ticker symbol, "AAPL"
@@ -51,6 +53,9 @@ company = get_company("aapl")  # Lookup Apple, Inc by its ticker symbol, "AAPL"
 print(f"Getting all transcripts for: {company}..")
 # Retrieve all earnings conference call events for a company, and iterate through each one
 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
     transcript = company.get_transcript(event=event)  # Fetch the earnings call transcript for this event
     print(f"* Q{event.quarter} {event.year}")
     if transcript:
@@ -102,6 +107,38 @@ Speaker: spk11
 Text: Good day, and welcome to the Apple Q3 FY 2021 Earnings Conference Call. Today's call is being recorded. At this time, for opening remarks and introductions, I would like to turn the call over to Tejas Ghala, Director, Investor Relations and Corporate Finance. Please go ahead.
 ```
 
+
+## Get Text by Speaker with Speaker Name and Title
+
+NOTE: This is a new experimental feature.  It includes Speaker Names and Titles.
+
+```python
+from earningscall import get_company
+
+company = get_company("aapl")  # Lookup Apple, Inc by its ticker symbol, "AAPL"
+
+transcript = company.get_transcript(year=2021, quarter=3, level=2)
+
+speaker = transcript.speakers[1]  # Get second speaker
+speaker_label = speaker.speaker_info.name
+text = speaker.text
+print("Speaker:")
+print(f"  Name: {speaker.speaker_info.name}")
+print(f"  Title: {speaker.speaker_info.title}")
+print()
+print(f"Text: {text}")
+```
+
+Output
+
+```text
+Speaker:
+  Name: Tejas Ghala
+  Title: Director, Investor Relations and Corporate Finance
+
+Text: Thank you. Good afternoon, and thank you for joining us. Speaking first today is Apple CEO Tim Cook, and he'll be followed by CFO Luca Maestri. After that, we'll open the call to questions from analysts. Please note that some of the information you'll hear during our discussion today will consist of forward-looking statements, including without limitation, those regarding revenue, gross margin, operating expenses, other income and expenses, taxes, capital allocation, and future business outlook, including the potential impact of COVID-19 on the company's business and results of operations. These statements involve risks and uncertainties that may cause actual results or trends to differ materially from our forecast. For more information, please refer to the risk factors discussed in Apple's most recently filed annual report on Form 10-K and the Form 8-K filed with the SEC today, along with the associated press release. Apple assumes no obligation to update any forward-looking statements or information which speak as of their respective dates. I'd like to now turn the call over to Tim for introductory remarks.
+```
+
 ## Get Word-Level Timestamps
 
 If you want to get the word-level timestamps, you can do so by setting the `level` parameter to `3`.

{earningscall-0.0.21 → earningscall-0.0.23}/earningscall/api.py

@@ -1,6 +1,8 @@
 import importlib
+import urllib.parse
 import logging
 import os
+from importlib.metadata import PackageNotFoundError
 from typing import Optional
 
 import requests
@@ -46,8 +48,15 @@ def purge_cache():
     return cache_session().cache.clear()
 
 
+def get_earnings_call_version():
+    try:
+        return importlib.metadata.version("earningscall")
+    except PackageNotFoundError:
+        return None
+
+
 def get_headers():
-    earnings_call_version = importlib.metadata.version("earningscall")
+    earnings_call_version = get_earnings_call_version()
     return {
         "User-Agent": f"EarningsCall Python/{earnings_call_version}",
         "X-EarningsCall-Version": earnings_call_version,
@@ -75,7 +84,9 @@ def do_get(
         **kwargs.get("params", {}),
     }
     url = f"{API_BASE}/{path}"
-    log.debug(f"do_get url: {url} params: {params}")
+    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:

{earningscall-0.0.21 → earningscall-0.0.23}/earningscall/company.py

@@ -92,6 +92,9 @@ class Company:
                 transcript.text = " ".join(map(lambda spk: spk.text, transcript.speakers))
             elif level == 4:
                 transcript.text = " ".join([transcript.prepared_remarks, transcript.questions_and_answers])
+            if transcript.speaker_name_map_v2:
+                for speaker in transcript.speakers:
+                    speaker.speaker_info = transcript.speaker_name_map_v2.get(speaker.speaker)
             return transcript
         except requests.exceptions.HTTPError as error:
             if error.response.status_code == 404:

{earningscall-0.0.21 → earningscall-0.0.23}/earningscall/transcript.py

@@ -1,15 +1,23 @@
 from dataclasses import dataclass, field
-from typing import List, Optional
+from typing import List, Optional, Dict
 
 from dataclasses_json import dataclass_json
 
 from earningscall.event import EarningsEvent
 
 
+@dataclass_json
+@dataclass
+class SpeakerInfo:
+    name: Optional[str] = field(default=None)
+    title: Optional[str] = field(default=None)
+
+
 @dataclass_json
 @dataclass
 class Speaker:
     speaker: str
+    speaker_info: Optional[SpeakerInfo] = field(default=None)
     text: Optional[str] = field(default=None)
     words: Optional[List[str]] = field(default=None)
     start_times: Optional[List[float]] = field(default=None)
@@ -23,3 +31,4 @@ class Transcript:
     speakers: Optional[List[Speaker]] = field(default=None)
     prepared_remarks: Optional[str] = field(default=None)
     questions_and_answers: Optional[str] = field(default=None)
+    speaker_name_map_v2: Optional[Dict[str, SpeakerInfo]] = field(default=None)

{earningscall-0.0.21 → earningscall-0.0.23}/hatch.toml

@@ -21,7 +21,7 @@ cov = [
 type = "container"
 
 [[envs.all.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"]
 
 [envs.lint]
 detached = true

{earningscall-0.0.21 → earningscall-0.0.23}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "earningscall"
-version = "0.0.21"
+version = "0.0.23"
 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 = [
@@ -161,3 +161,6 @@ exclude_lines = [
     "if __name__ == .__main__.:",
     "if TYPE_CHECKING:",
 ]
+
+[tool.pytest.ini_options]
+log_level = "DEBUG"

{earningscall-0.0.21 → earningscall-0.0.23}/scripts/download_audio_files.py

@@ -1,4 +1,5 @@
 import argparse
+from datetime import datetime
 import os
 
 import earningscall  # noqa: F401
@@ -26,6 +27,11 @@ os.makedirs(directory, exist_ok=True)
 def download_audio_files(company: Company):
     print(f"Downloading all audio files 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}.mp3",

{earningscall-0.0.21 → earningscall-0.0.23}/scripts/download_sp500_audio_files.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 import os
 
 import earningscall  # noqa: F401
@@ -14,6 +15,11 @@ os.makedirs(directory, exist_ok=True)
 def download_audio_files(company: Company):
     print(f"Downloading all audio files 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}.mp3",

{earningscall-0.0.21 → earningscall-0.0.23}/scripts/get_single_transcript.py

@@ -9,5 +9,13 @@ from earningscall import get_company
 
 company = get_company("aapl")
 
-transcript = company.get_transcript(year=2021, quarter=3, level=4)
-print(f"{company} Q3 2021 Transcript Text: \"{transcript.text[:100]}...\"")
+transcript = company.get_transcript(year=2021, quarter=3, level=2)
+
+speaker = transcript.speakers[1]
+speaker_label = speaker.speaker_info.name
+text = speaker.text
+print("Speaker:")
+print(f"  Name: {speaker.speaker_info.name}")
+print(f"  Title: {speaker.speaker_info.title}")
+print()
+print(f"Text: {text}")