earningscall 0.0.7__tar.gz → 0.0.9__tar.gz

{earningscall-0.0.7 → earningscall-0.0.9}/DEVELOPMENT.md

@@ -28,10 +28,10 @@ def test_save_symbols_v1():
 
 ### Publishing a new Version to PyPI
 
-Make your changes
+Assuming you want to publish version 0.0.7, first, make your changes, then run the commands:
 
 ```sh
 git commit -a
-git tag v0.0.6
-
-```
+git tag v0.0.7
+git push --atomic origin master v0.0.7
+```

{earningscall-0.0.7 → earningscall-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: earningscall
-Version: 0.0.7
+Version: 0.0.9
 Summary: The EarningsCall Python library.
 Project-URL: Homepage, https://earningscall.biz
 Project-URL: Documentation, https://github.com/EarningsCall/earningscall-python
@@ -44,7 +44,6 @@ pip install --upgrade earningscall
 ```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)
@@ -64,13 +63,12 @@ Apple Inc. Q3 2021 Transcript Text: "Good day, and welcome to the Apple Q3 FY 20
 ```python
 from earningscall import get_company
 
-
 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():
-    transcript = company.get_transcript(event)  # Fetch the earnings call transcript for this event
+    transcript = company.get_transcript(event=event)  # Fetch the earnings call transcript for this event
     print(f"* Q{event.quarter} {event.year}")
     if transcript:
         print(f"  Transcript Text: \"{transcript.text[:100]}...\"")
@@ -105,6 +103,15 @@ for company in get_all_companies():
     print(f"{company.company_info} -- {company.company_info.sector} -- {company.company_info.industry}")
 ```
 
+## List S&P 500 Companies
+
+```python
+from earningscall import get_all_companies
+
+for company in get_all_companies():
+    print(f"{company.company_info} -- {company.company_info.sector} -- {company.company_info.industry}")
+```
+
 By default, this library grants you access to only two companies, Apple Inc. and Microsoft, Inc.
 
 To gain access to 5,000+ companies please [signup here](https://earningscall.biz/api-pricing) to get your API key.

{earningscall-0.0.7 → earningscall-0.0.9}/README.md

@@ -26,7 +26,6 @@ pip install --upgrade earningscall
 ```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)
@@ -46,13 +45,12 @@ Apple Inc. Q3 2021 Transcript Text: "Good day, and welcome to the Apple Q3 FY 20
 ```python
 from earningscall import get_company
 
-
 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():
-    transcript = company.get_transcript(event)  # Fetch the earnings call transcript for this event
+    transcript = company.get_transcript(event=event)  # Fetch the earnings call transcript for this event
     print(f"* Q{event.quarter} {event.year}")
     if transcript:
         print(f"  Transcript Text: \"{transcript.text[:100]}...\"")
@@ -87,6 +85,15 @@ for company in get_all_companies():
     print(f"{company.company_info} -- {company.company_info.sector} -- {company.company_info.industry}")
 ```
 
+## List S&P 500 Companies
+
+```python
+from earningscall import get_all_companies
+
+for company in get_all_companies():
+    print(f"{company.company_info} -- {company.company_info.sector} -- {company.company_info.industry}")
+```
+
 By default, this library grants you access to only two companies, Apple Inc. and Microsoft, Inc.
 
 To gain access to 5,000+ companies please [signup here](https://earningscall.biz/api-pricing) to get your API key.

earningscall-0.0.9/TODO.md

@@ -0,0 +1,9 @@
+# A list of things left to do for this project
+
+* Cache symbols on disk, to avoid redundant network calls
+
+
+
+# Considerations
+
+* Consider implementing @dataclass and @dataclass_json from scratch to avoid third-party dependency

{earningscall-0.0.7 → earningscall-0.0.9}/earningscall/api.py

@@ -2,9 +2,9 @@ import logging
 import os
 from typing import Optional
 
-import earningscall
 import requests
 
+import earningscall
 
 log = logging.getLogger(__file__)
 
@@ -19,6 +19,10 @@ def get_api_key():
     return api_key
 
 
+def api_key_param():
+    return {"apikey": get_api_key()}
+
+
 def is_demo_account():
     return get_api_key() == "demo"
 
@@ -28,7 +32,7 @@ def get_events(exchange: str,
 
     log.debug(f"get_events exchange: {exchange} symbol: {symbol}")
     params = {
-        "apikey": get_api_key(),
+        **api_key_param(),
         "exchange": exchange,
         "symbol": symbol,
     }
@@ -45,7 +49,7 @@ def get_transcript(exchange: str,
 
     log.debug(f"get_transcript year: {year} quarter: {quarter}")
     params = {
-        "apikey": get_api_key(),
+        **api_key_param(),
         "exchange": exchange,
         "symbol": symbol,
         "year": str(year),
@@ -65,10 +69,14 @@ def get_symbols_v1():
 
 
 def get_symbols_v2():
-    params = {
-        "apikey": get_api_key(),
-    }
-    response = requests.get(f"{API_BASE}/symbols-v2.txt", params=params)
+    response = requests.get(f"{API_BASE}/symbols-v2.txt", params=api_key_param())
+    if response.status_code != 200:
+        return None
+    return response.text
+
+
+def get_sp500_companies_txt_file():
+    response = requests.get(f"{API_BASE}/symbols/sp500.txt", params=api_key_param())
     if response.status_code != 200:
         return None
     return response.text

{earningscall-0.0.7 → earningscall-0.0.9}/earningscall/errors.py

@@ -23,7 +23,3 @@ class ClientError(BaseError):
 
 class InsufficientApiAccessError(ClientError):
     pass
-
-
-class CompanyNotFound(ClientError):
-    pass

{earningscall-0.0.7 → earningscall-0.0.9}/earningscall/exports.py

@@ -1,8 +1,8 @@
 from typing import Optional
 
-from earningscall.symbols import get_symbols
-
+from earningscall.api import get_sp500_companies_txt_file
 from earningscall.company import Company
+from earningscall.symbols import get_symbols
 
 
 def get_company(symbol: str) -> Optional[Company]:
@@ -18,6 +18,10 @@ 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)
+    resp = get_sp500_companies_txt_file()
+    if not resp:
+        return []
+    for ticker_symbol in resp.split("\n"):
+        company_info = get_symbols().lookup_company(ticker_symbol)
+        if company_info:
+            yield Company(company_info=company_info)

{earningscall-0.0.7 → earningscall-0.0.9}/earningscall/symbols.py

@@ -129,8 +129,8 @@ class Symbols:
             except KeyError:
                 pass
         if is_demo_account():
-            raise InsufficientApiAccessError(f"For full access, please get an API Key.  See: "
-                                             f"https://earningscall.biz/api-pricing")
+            raise InsufficientApiAccessError(f"\"{symbol}\" requires an API Key for access.  To get your API Key,"
+                                             f" see: https://earningscall.biz/api-pricing")
         return None
 
     def remove_exchange_symbol(self, exchange_symbol: str):

{earningscall-0.0.7 → earningscall-0.0.9}/earningscall/transcript.py

@@ -3,6 +3,7 @@ from typing import Optional
 
 from dataclasses import dataclass, field
 from dataclasses_json import dataclass_json
+
 from earningscall.event import EarningsEvent
 
 log = logging.getLogger(__file__)

earningscall-0.0.9/earningscall/utils.py

@@ -0,0 +1,33 @@
+import logging
+import os
+import pathlib
+import sys
+
+import earningscall
+
+
+def project_file_path(base_dir, file_name):
+    result = os.path.join(pathlib.Path(earningscall.__file__).resolve().parent.parent, base_dir)
+    if file_name is None:
+        return result
+    return os.path.join(result, file_name)
+
+
+def data_path(file_name=None):
+    return project_file_path("tests/data", file_name)
+
+
+def enable_debug_logs():
+    logging.basicConfig(level=logging.DEBUG)
+
+
+LOG_FORMAT = "[%(asctime)s] [%(levelname)8s] --- %(message)s (%(filename)s:%(lineno)s)"
+
+
+def configure_sane_logging(level=logging.DEBUG):
+    # Manually set the following loggers to "INFO", since they tend to be VERY noisy, and when we are
+    # debugging our own application, we only care about DEBUG logs from OUR application, not these libs.
+    for name in ['urllib3']:
+        logging.getLogger(name).setLevel(logging.INFO)
+    logging.getLogger("filelock").setLevel(logging.WARNING)
+    logging.basicConfig(level=level, stream=sys.stdout, format=LOG_FORMAT)

{earningscall-0.0.7 → earningscall-0.0.9}/pyproject.toml

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

earningscall-0.0.9/scripts/list_companies.py

@@ -0,0 +1,25 @@
+import argparse
+import logging
+
+from earningscall import get_all_companies
+from earningscall.exports import get_sp500_companies
+from earningscall.utils import configure_sane_logging
+
+
+parser = argparse.ArgumentParser(description='')
+parser.add_argument('--debug', action='store_true', help='Enable debug logs')
+parser.add_argument('--sp-500', action='store_true', help='Show S&P500 Companies')
+
+args = parser.parse_args()
+level = logging.DEBUG
+if args.debug:
+    level = logging.DEBUG
+configure_sane_logging(level=level)
+
+if args.sp_500:
+    get_func = get_sp500_companies
+else:
+    get_func = get_all_companies
+
+for company in get_func():
+    print(f"{company.company_info} -- {company.company_info.sector} -- {company.company_info.industry}")

earningscall-0.0.7/TODO.md

@@ -1,5 +0,0 @@
-# A list of things left to do for this project
-
-* Allow user to set API Key
-* If user is using "demo" API key, and user tries to get non-demo symbol, throw a nice error message
-

earningscall-0.0.7/earningscall/utils.py

@@ -1,20 +0,0 @@
-import logging
-import os
-import pathlib
-
-import earningscall
-
-
-def project_file_path(base_dir, file_name):
-    result = os.path.join(pathlib.Path(earningscall.__file__).resolve().parent.parent, base_dir)
-    if file_name is None:
-        return result
-    return os.path.join(result, file_name)
-
-
-def data_path(file_name=None):
-    return project_file_path("tests/data", file_name)
-
-
-def enable_debug_logs():
-    logging.basicConfig(level=logging.DEBUG)

earningscall-0.0.7/scripts/list_all_companies.py

@@ -1,8 +0,0 @@
-from earningscall import get_all_companies
-from earningscall.utils import enable_debug_logs
-
-
-enable_debug_logs()
-
-for company in get_all_companies():
-    print(f"{company.company_info} -- {company.company_info.sector} -- {company.company_info.industry}")

earningscall-0.0.7/tests/test_simple.py

@@ -1,27 +0,0 @@
-import responses
-import requests
-# from responses import _recorder
-
-
-@responses.activate
-def test_simple():
-    responses.add(responses.GET, 'http://twitter.com/api/1/foobar',
-                  json={'error': 'not found'}, status=404)
-
-    resp = requests.get('http://twitter.com/api/1/foobar')
-
-    assert resp.json() == {"error": "not found"}
-
-    assert len(responses.calls) == 1
-    assert responses.calls[0].request.url == 'http://twitter.com/api/1/foobar'
-    assert responses.calls[0].response.text == '{"error": "not found"}'
-
-
-# @_recorder.record(file_path="symbols.yaml")
-# def test_save_symbols_v1():
-#     requests.get("https://earningscall.biz/symbols.txt")
-#
-#
-# @_recorder.record(file_path="symbols-v2.yaml")
-# def test_save_symbols_v1():
-#     requests.get("https://earningscall.biz/symbols-v2.txt")

{earningscall-0.0.7 → earningscall-0.0.9}/earningscall/__init__.py

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

{earningscall-0.0.7 → earningscall-0.0.9}/earningscall/event.py

@@ -1,8 +1,8 @@
 import logging
-from dataclasses import dataclass, field
 from datetime import datetime
 from typing import Optional
 
+from dataclasses import dataclass, field
 from dataclasses_json import config
 from dataclasses_json import dataclass_json
 from marshmallow import fields