earningscall 0.0.19__tar.gz → 0.0.21__tar.gz

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

@@ -1,3 +1,11 @@
+## Release `0.0.21` - 2024-10-07
+
+* Bump version for PyPI release: updated README docs.
+
+## Release `0.0.20` - 2024-10-07
+
+* Bugfix: Fix importlib error.
+
 ## Release `0.0.19` - 2024-10-07
 
 * Add Advanced Transcript Data structures (Beta: and subject to change in the future).

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: earningscall
-Version: 0.0.19
+Version: 0.0.21
 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
@@ -126,6 +126,98 @@ Getting all transcripts for: Apple Inc...
   ...
 ```
 
+
+## Get Text by Speaker
+
+If you want to get the text by speaker, you can do so by setting the `level` parameter to `2`.
+
+NOTE: Level `2` data is provided in any plan that includes Enhanced Transcript Data.
+
+```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)
+
+first_speaker = transcript.speakers[0]
+speaker_label = first_speaker.speaker
+text = first_speaker.text
+print(f"Speaker: {speaker_label}\nText: {text}")
+```
+
+Output
+
+```text
+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 Word-Level Timestamps
+
+If you want to get the word-level timestamps, you can do so by setting the `level` parameter to `3`.
+
+Each timestamp is the number of seconds since the start of the transcript.
+
+NOTE: Level `3` data is provided in any plan that includes Enhanced Transcript Data.
+
+
+```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=3)
+
+first_speaker = transcript.speakers[0]
+words_and_start_times = list(zip(first_speaker.words, first_speaker.start_times))
+print(f"Speaker: {first_speaker.speaker}")
+print(f"Words with start times: {words_and_start_times}")
+```
+
+Output
+
+```text
+Speaker: spk11
+Words with start times: [('Good', 0.049), ('day,', 0.229), ('and', 0.489), ('welcome', 0.609), ('to', 0.929), ('the', 1.029), ('Apple', 1.229), ('Q3', 1.629), ('FY', 2.65), ('2021', 2.6599999999999997), ('Earnings', 3.81), ('Conference', 4.17), ('Call.', 4.55), ("Today's", 5.411), ('call', 5.811), ('is', 6.111), ('being', 6.271), ('recorded.', 6.471), ('At', 7.571), ('this', 7.671), ('time,', 7.871), ('for', 8.111), ('opening', 8.351), ('remarks', 8.631), ('and', 9.092), ('introductions,', 9.232), ('I', 9.832), ('would', 9.912), ('like', 10.052), ('to', 10.192), ('turn', 10.292), ('the', 10.492), ('call', 10.592), ('over', 10.872), ('to', 11.052), ('Tejas', 11.152), ('Ghala,', 11.532), ('Director,', 12.112), ('Investor', 12.533), ('Relations', 12.873), ('and', 13.353), ('Corporate', 13.473), ('Finance.', 13.773), ('Please', 14.413), ('go', 14.653), ('ahead.', 14.793)]
+```
+
+## Get Prepared Remarks and Q&A for a Single Quarter
+
+If you want to get the prepared remarks and Q&A for a single quarter, you can do so by setting the `level` parameter to `4`.
+
+NOTE: Level `4` data is provided in any plan that includes Enhanced Transcript Data.
+
+```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=4)
+print(f"{company} Q3 2021 Prepared Remarks: \"{transcript.prepared_remarks[:100]}...\"")
+print(f"{company} Q3 2021 Q&A: \"{transcript.questions_and_answers[:100]}...\"")
+```
+
+Output
+
+```text
+Apple Inc. Q3 2021 Prepared Remarks: "Good day, and welcome to the Apple Q3 FY 2021 Earnings Conference Call. Today's call is being record..."
+Apple Inc. Q3 2021 Q&A: "Our first question comes from Katie Huberty from Morgan Stanley. Please go ahead. Hello, Katie. Your..."
+```
+
+## Download Audio File
+
+If you want to download the audio file for a single quarter, you can call the `download_audio_file` function.
+
+```python
+from earningscall import get_company
+
+company = get_company("aapl")  # Lookup Apple, Inc by its ticker symbol, "AAPL"
+
+print("Downloading audio file for Apple Inc. Q3 2021...")
+audio_file = company.download_audio_file(year=2021, quarter=3, file_name="Apple Q3 2021.mp3")
+```
+
 ## List All Companies
 
 ```python

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

@@ -75,6 +75,98 @@ Getting all transcripts for: Apple Inc...
   ...
 ```
 
+
+## Get Text by Speaker
+
+If you want to get the text by speaker, you can do so by setting the `level` parameter to `2`.
+
+NOTE: Level `2` data is provided in any plan that includes Enhanced Transcript Data.
+
+```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)
+
+first_speaker = transcript.speakers[0]
+speaker_label = first_speaker.speaker
+text = first_speaker.text
+print(f"Speaker: {speaker_label}\nText: {text}")
+```
+
+Output
+
+```text
+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 Word-Level Timestamps
+
+If you want to get the word-level timestamps, you can do so by setting the `level` parameter to `3`.
+
+Each timestamp is the number of seconds since the start of the transcript.
+
+NOTE: Level `3` data is provided in any plan that includes Enhanced Transcript Data.
+
+
+```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=3)
+
+first_speaker = transcript.speakers[0]
+words_and_start_times = list(zip(first_speaker.words, first_speaker.start_times))
+print(f"Speaker: {first_speaker.speaker}")
+print(f"Words with start times: {words_and_start_times}")
+```
+
+Output
+
+```text
+Speaker: spk11
+Words with start times: [('Good', 0.049), ('day,', 0.229), ('and', 0.489), ('welcome', 0.609), ('to', 0.929), ('the', 1.029), ('Apple', 1.229), ('Q3', 1.629), ('FY', 2.65), ('2021', 2.6599999999999997), ('Earnings', 3.81), ('Conference', 4.17), ('Call.', 4.55), ("Today's", 5.411), ('call', 5.811), ('is', 6.111), ('being', 6.271), ('recorded.', 6.471), ('At', 7.571), ('this', 7.671), ('time,', 7.871), ('for', 8.111), ('opening', 8.351), ('remarks', 8.631), ('and', 9.092), ('introductions,', 9.232), ('I', 9.832), ('would', 9.912), ('like', 10.052), ('to', 10.192), ('turn', 10.292), ('the', 10.492), ('call', 10.592), ('over', 10.872), ('to', 11.052), ('Tejas', 11.152), ('Ghala,', 11.532), ('Director,', 12.112), ('Investor', 12.533), ('Relations', 12.873), ('and', 13.353), ('Corporate', 13.473), ('Finance.', 13.773), ('Please', 14.413), ('go', 14.653), ('ahead.', 14.793)]
+```
+
+## Get Prepared Remarks and Q&A for a Single Quarter
+
+If you want to get the prepared remarks and Q&A for a single quarter, you can do so by setting the `level` parameter to `4`.
+
+NOTE: Level `4` data is provided in any plan that includes Enhanced Transcript Data.
+
+```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=4)
+print(f"{company} Q3 2021 Prepared Remarks: \"{transcript.prepared_remarks[:100]}...\"")
+print(f"{company} Q3 2021 Q&A: \"{transcript.questions_and_answers[:100]}...\"")
+```
+
+Output
+
+```text
+Apple Inc. Q3 2021 Prepared Remarks: "Good day, and welcome to the Apple Q3 FY 2021 Earnings Conference Call. Today's call is being record..."
+Apple Inc. Q3 2021 Q&A: "Our first question comes from Katie Huberty from Morgan Stanley. Please go ahead. Hello, Katie. Your..."
+```
+
+## Download Audio File
+
+If you want to download the audio file for a single quarter, you can call the `download_audio_file` function.
+
+```python
+from earningscall import get_company
+
+company = get_company("aapl")  # Lookup Apple, Inc by its ticker symbol, "AAPL"
+
+print("Downloading audio file for Apple Inc. Q3 2021...")
+audio_file = company.download_audio_file(year=2021, quarter=3, file_name="Apple Q3 2021.mp3")
+```
+
 ## List All Companies
 
 ```python

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

@@ -12,7 +12,6 @@ log = logging.getLogger(__file__)
 
 DOMAIN = os.environ.get("ECALL_DOMAIN", "earningscall.biz")
 API_BASE = f"https://v2.api.{DOMAIN}"
-EARNINGS_CALL_VERSION = importlib.metadata.version("earningscall")
 
 
 def get_api_key():
@@ -48,9 +47,10 @@ def purge_cache():
 
 
 def get_headers():
+    earnings_call_version = importlib.metadata.version("earningscall")
     return {
-        "User-Agent": f"EarningsCall Python/{EARNINGS_CALL_VERSION}",
-        "X-EarningsCall-Version": EARNINGS_CALL_VERSION,
+        "User-Agent": f"EarningsCall Python/{earnings_call_version}",
+        "X-EarningsCall-Version": earnings_call_version,
     }
 
 

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

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