earningscall 0.0.4__py3-none-any.whl → 0.0.5__py3-none-any.whl

earningscall/api.py

@@ -19,6 +19,10 @@ def get_api_key():
     return api_key
 
 
+def is_demo_account():
+    return get_api_key() == "demo"
+
+
 def get_events(exchange: str,
                symbol: str):
 
@@ -41,7 +45,7 @@ def get_transcript(exchange: str,
 
     log.debug(f"get_transcript year: {year} quarter: {quarter}")
     params = {
-        "apikey": "demo",
+        "apikey": get_api_key(),
         "exchange": exchange,
         "symbol": symbol,
         "year": str(year),
@@ -61,7 +65,10 @@ def get_symbols_v1():
 
 
 def get_symbols_v2():
-    response = requests.get(f"{API_BASE}/symbols-v2.txt")
+    params = {
+        "apikey": get_api_key(),
+    }
+    response = requests.get(f"{API_BASE}/symbols-v2.txt", params=params)
     if response.status_code != 200:
         return None
     return response.text

earningscall/company.py

@@ -15,7 +15,9 @@ class Company:
     name: str
     _events: [EarningsEvent]
 
-    def __init__(self, company_info):
+    def __init__(self, company_info: CompanyInfo):
+        if not company_info:
+            raise ValueError("company_info must be present.")
         self.company_info = company_info
         self.name = company_info.name
         self._events = None

earningscall/errors.py

@@ -21,5 +21,9 @@ class ClientError(BaseError):
     status: int = 400  # https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400
 
 
-class MissingApiKeyError(ClientError):
+class InsufficientApiAccessError(ClientError):
+    pass
+
+
+class CompanyNotFound(ClientError):
     pass

earningscall/exports.py

@@ -1,10 +1,15 @@
+from typing import Optional
+
 from earningscall.symbols import get_symbols
 
 from earningscall.company import Company
 
 
-def get_company(symbol: str) -> Company:
-    return Company(company_info=get_symbols().lookup_company(symbol))
+def get_company(symbol: str) -> Optional[Company]:
+    company_info = get_symbols().lookup_company(symbol)
+    if company_info:
+        return Company(company_info=company_info)
+    return None
 
 
 def get_all_companies() -> [Company]:

earningscall/symbols.py

@@ -4,7 +4,8 @@ import re
 from collections import defaultdict
 from typing import Optional
 
-from earningscall.api import get_symbols_v2
+from earningscall.api import get_symbols_v2, is_demo_account
+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
@@ -127,6 +128,9 @@ class Symbols:
                     return _symbol
             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")
         return None
 
     def remove_exchange_symbol(self, exchange_symbol: str):
@@ -224,3 +228,8 @@ def get_symbols() -> Symbols:
     if not _symbols:
         _symbols = load_symbols()
     return _symbols
+
+
+def clear_symbols():
+    global _symbols
+    _symbols = None

earningscall/utils.py

@@ -1,3 +1,4 @@
+import logging
 import os
 import pathlib
 
@@ -13,3 +14,7 @@ def project_file_path(base_dir, 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.4.dist-info → earningscall-0.0.5.dist-info}/METADATA

@@ -1,10 +1,13 @@
 Metadata-Version: 2.3
 Name: earningscall
-Version: 0.0.4
+Version: 0.0.5
 Summary: The EarningsCall Python library.
+Project-URL: Homepage, https://earningscall.biz
 Project-URL: Documentation, https://github.com/EarningsCall/earningscall-python
+Project-URL: Repository, https://github.com/EarningsCall/earningscall-python
 Project-URL: Issues, https://github.com/EarningsCall/earningscall-python/issues
 Project-URL: Source, https://github.com/EarningsCall/earningscall-python
+Project-URL: Changelog, https://github.com/EarningsCall/earningscall-python/blob/master/CHANGELOG.md
 Author-email: EarningsCall <dev@earningscall.biz>
 License-File: LICENSE
 Requires-Python: >=3.8
@@ -16,7 +19,11 @@ Description-Content-Type: text/markdown
 
 # EarningsCall Python Library
 
-The EarningsCall Python library provides convenient access to the EarningsCall API from
+[![pypi](https://img.shields.io/pypi/v/earningscall.svg)](https://pypi.python.org/pypi/earningscall)
+[![Build Status](https://github.com/EarningsCall/earningscall-python/actions/workflows/release.yml/badge.svg?branch=master)](https://github.com/EarningsCall/earningscall-python/actions?query=branch%3Amaster)
+[![Coverage Status](https://coveralls.io/repos/github/EarningsCall/earningscall-python/badge.svg?branch=master)](https://coveralls.io/github/EarningsCall/earningscall-python?branch=master)
+
+The EarningsCall Python library provides convenient access to the [EarningsCall API](https://earningscall.biz/api-guide) from
 applications written in the Python language. It includes a pre-defined set of
 classes for API resources that initialize themselves dynamically from API
 responses.
@@ -33,7 +40,6 @@ pip install --upgrade earningscall
 
 * Python 3.8+ (PyPI supported)
 
-
 ## Get Transcript for a Single Quarter
 
 ```python
@@ -99,3 +105,24 @@ 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 5,000+ companies please [signup here](https://earningscall.biz/api-pricing) to get your API key.
+
+Once you have access to your API key, you can set the API Key like this:
+
+```python
+
+import earningscall
+
+
+earningscall.api_key = "YOUR SECRET API KEY GOES HERE"
+```
+
+Alternatively, you can pass in your API key as an environment variable:
+
+```sh
+export ECALL_API_KEY="YOUR SECRET API KEY GOES HERE"
+python your-python-script.py
+```

earningscall-0.0.5.dist-info/RECORD

@@ -0,0 +1,14 @@
+earningscall/__init__.py,sha256=Hfh2BCnihAqfWV9niZrlfHmTNuL5tEKTW37bAXGLrF0,119
+earningscall/api.py,sha256=_RnCSaZSUZJPvr_SiEk7YJZ8tkP9buLDQKReTWOZEPk,1749
+earningscall/company.py,sha256=Xi5kJPt14mLD7nTC8KEQhnJjRktmxb7pWMVdVUQ1TH0,1714
+earningscall/errors.py,sha256=YTLkbhzWT_AURRL1IMlkkAKUiIW1L4V9Qh99bZnOtd8,488
+earningscall/event.py,sha256=a5mcyfuCqPCopcKQUZ1HJyqHfAf-RNKnux_o68DIUHM,689
+earningscall/exports.py,sha256=EfuxNiKnLktlD4ZtBm89qwfKRgKXh3C7bjleEhvBhzQ,590
+earningscall/sectors.py,sha256=9aw14krRzdLJSTFC72Nwk3MQaXAIgkTBk5S-KTiki3U,5946
+earningscall/symbols.py,sha256=fvqjnCbSAwfZB1dUrBUZFmJQ8C8V9uDzR0_C9RXMfIs,7722
+earningscall/transcript.py,sha256=gV0Pqc9iilg4QQc89-ADEIcFQkQhFSnsJo8rvF7zKp0,192
+earningscall/utils.py,sha256=wfwlSgFPPxr3GsFAsTjDNg_mLLK9V6p_2CwfetN5RR0,454
+earningscall-0.0.5.dist-info/METADATA,sha256=p-Ps1OB2QmIssJMvS70roI6ElbGqumOhJK1z0gAMubM,4241
+earningscall-0.0.5.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
+earningscall-0.0.5.dist-info/licenses/LICENSE,sha256=ktEB_UcRMg2cQlX9wiDs544xWncWizwS9mEZuGsCLrM,1069
+earningscall-0.0.5.dist-info/RECORD,,

earningscall-0.0.4.dist-info/RECORD

@@ -1,14 +0,0 @@
-earningscall/__init__.py,sha256=Hfh2BCnihAqfWV9niZrlfHmTNuL5tEKTW37bAXGLrF0,119
-earningscall/api.py,sha256=lBUzBUjq_WNt4DH1usszG6OYJtBQbGYOy6KY0ags8ZI,1613
-earningscall/company.py,sha256=fGbfh4S1m1K0rgkzpToYOrkPOZSJQieen6RJlSIvCjY,1610
-earningscall/errors.py,sha256=Y5LVdvOMz_FgCXu4gXnyHceGvQwWmjHbkbRU2dsgdtA,433
-earningscall/event.py,sha256=a5mcyfuCqPCopcKQUZ1HJyqHfAf-RNKnux_o68DIUHM,689
-earningscall/exports.py,sha256=bG2ehoILyGTUrgRleuub4tXkiVGUdUZgsmoJ6giQgj4,478
-earningscall/sectors.py,sha256=9aw14krRzdLJSTFC72Nwk3MQaXAIgkTBk5S-KTiki3U,5946
-earningscall/symbols.py,sha256=mYWVO3YcUEr6JDxoH238_lsz67QHJGhk-o6jN1ot7R4,7372
-earningscall/transcript.py,sha256=gV0Pqc9iilg4QQc89-ADEIcFQkQhFSnsJo8rvF7zKp0,192
-earningscall/utils.py,sha256=g0MI9apoAQ2L7Ccj91mOHUWAE7zFbAvWqHPMjMJesFk,367
-earningscall-0.0.4.dist-info/METADATA,sha256=1U9i621evx8KJEcdpm9iOgVV8Vrkeyr19APTa-DqTek,2935
-earningscall-0.0.4.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-earningscall-0.0.4.dist-info/licenses/LICENSE,sha256=ktEB_UcRMg2cQlX9wiDs544xWncWizwS9mEZuGsCLrM,1069
-earningscall-0.0.4.dist-info/RECORD,,