Properly support earningscall.api_key.

Additionally, add event structure to Transcript object.

DEVELOPMENT.md

@@ -23,3 +23,15 @@ def test_save_symbols_v1():
 def test_save_symbols_v1():
     requests.get("https://earningscall.biz/symbols-v2.txt")
 ```
+
+
+
+### Publishing a new Version to PyPI
+
+Make your changes
+
+```sh
+git commit -a
+git tag v0.0.6
+
+```

earningscall/__init__.py

@@ -1,2 +1,6 @@
+from typing import Optional
+
 from earningscall.symbols import Symbols, load_symbols
 from earningscall.exports import get_company, get_all_companies
+
+api_key: Optional[str] = None

earningscall/api.py

@@ -2,19 +2,19 @@
 import os
 from typing import Optional
 
+import earningscall
 import requests
 
 
 log = logging.getLogger(__file__)
 
 DOMAIN = os.environ.get("ECALL_DOMAIN", "earningscall.biz")
 API_BASE = f"https://v2.api.{DOMAIN}"
-api_key: Optional[str] = None
 
 
 def get_api_key():
-    global api_key
-    if api_key is None:
+    api_key = earningscall.api_key
+    if not api_key:
         return os.environ.get("ECALL_API_KEY", "demo")
     return api_key
 

earningscall/exports.py

@@ -18,5 +18,6 @@ def get_all_companies() -> [Company]:
 
 
 def get_sp500_companies() -> [Company]:
+    ## TODO: Actually only return SP500 companies.
     for company_info in get_symbols().get_all():
         yield Company(company_info=company_info)

earningscall/transcript.py

@@ -1,7 +1,9 @@
 import logging
-from dataclasses import dataclass
+from typing import Optional
 
+from dataclasses import dataclass, field
 from dataclasses_json import dataclass_json
+from earningscall.event import EarningsEvent
 
 log = logging.getLogger(__file__)
 
@@ -11,4 +13,4 @@
 class Transcript:
 
     text: str
-
+    event: Optional[EarningsEvent] = field(default=None)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "earningscall"
-version = "0.0.6"
+version = "0.0.7"
 description = "The EarningsCall Python library."
 readme = "README.md"
 authors = [

tests/test_get_transcript.py

@@ -29,6 +29,23 @@ def test_get_demo_company():
                                      'Conference Call. At ')
 
 
+@responses.activate
+def test_get_demo_company_with_event_populated():
+    ##
+    clear_symbols()
+    responses._add_from_file(file_path=data_path("symbols-v2.yaml"))
+    responses._add_from_file(file_path=data_path("demo-symbols-v2-alpha.yaml"))
+    ##
+    company = get_company("aapl")
+    ##
+    transcript = company.get_transcript(year=2022, quarter=1)
+    assert transcript.event.year == 2022
+    assert transcript.event.quarter == 1
+    assert transcript.event.conference_date.isoformat() == "2022-01-19T00:00:00-08:00"
+    assert transcript.text[:100] == ("Good day and welcome to the Apple Q1 Fiscal Year 2021 earnings conference "
+                                     "call. Today's call is bein")
+
+
 # Uncomment and run following code to generate demo-symbols-v2.yaml file
 #
 # import requests
@@ -40,6 +57,18 @@ def test_get_demo_company():
 # def test_save_symbols_v1():
 #     requests.get("https://v2.api.earningscall.biz/symbols-v2.txt?apikey=demo")
 
+# Uncomment and run following code to generate demo-symbols-v2.yaml file
+#
+# import requests
+#
+# from responses import _recorder
+#
+#
+# @_recorder.record(file_path="demo-symbols-v2-alpha.yaml")
+# def test_save_symbols_v1():
+#     requests.get("https://v2.api.alpha.earningscall.biz/transcript?apikey=demo&exchange=NASDAQ&symbol=AAPL&year=2022&quarter=q1")
+#
+
 
 @responses.activate
 def test_get_non_demo_company():