earningscall 0.0.8__tar.gz → 0.0.10__tar.gz

{earningscall-0.0.8 → earningscall-0.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: earningscall
-Version: 0.0.8
+Version: 0.0.10
 Summary: The EarningsCall Python library.
 Project-URL: Homepage, https://earningscall.biz
 Project-URL: Documentation, https://github.com/EarningsCall/earningscall-python
@@ -9,6 +9,27 @@ 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: MIT License
+        
+        Copyright (c) 2024 EarningsCall
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        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
 Requires-Python: >=3.8
 Requires-Dist: dataclasses-json>=0.6.4
@@ -44,7 +65,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,7 +84,6 @@ 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}..")
@@ -94,8 +113,6 @@ Getting all transcripts for: Apple Inc...
   ...
 ```
 
-
-
 ## List All Companies
 
 ```python
@@ -125,3 +142,13 @@ Alternatively, you can pass in your API key as an environment variable:
 export ECALL_API_KEY="YOUR SECRET API KEY GOES HERE"
 python your-python-script.py
 ```
+
+## List S&P 500 Companies
+
+```python
+from earningscall import get_sp500_companies
+
+for company in get_sp500_companies():
+    print(f"{company.company_info} -- {company.company_info.sector} -- {company.company_info.industry}")
+```
+

{earningscall-0.0.8 → earningscall-0.0.10}/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,7 +45,6 @@ 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}..")
@@ -76,8 +74,6 @@ Getting all transcripts for: Apple Inc...
   ...
 ```
 
-
-
 ## List All Companies
 
 ```python
@@ -107,3 +103,13 @@ Alternatively, you can pass in your API key as an environment variable:
 export ECALL_API_KEY="YOUR SECRET API KEY GOES HERE"
 python your-python-script.py
 ```
+
+## List S&P 500 Companies
+
+```python
+from earningscall import get_sp500_companies
+
+for company in get_sp500_companies():
+    print(f"{company.company_info} -- {company.company_info.sector} -- {company.company_info.industry}")
+```
+

{earningscall-0.0.8 → earningscall-0.0.10}/earningscall/__init__.py

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

{earningscall-0.0.8 → earningscall-0.0.10}/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.8 → earningscall-0.0.10}/earningscall/errors.py

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

{earningscall-0.0.8 → earningscall-0.0.10}/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.8 → earningscall-0.0.10}/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.8 → earningscall-0.0.10}/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.8 → earningscall-0.0.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "earningscall"
-version = "0.0.8"
+version = "0.0.10"
 description = "The EarningsCall Python library."
 readme = "README.md"
 authors = [
@@ -12,6 +12,7 @@ dependencies = [
     "dataclasses-json>=0.6.4",
     "requests>=2.30.0",
 ]
+license = { file = "LICENSE" }
 
 [project.urls]
 Homepage = "https://earningscall.biz"

earningscall-0.0.10/scripts/list_companies.py

@@ -0,0 +1,24 @@
+import argparse
+import logging
+
+from earningscall import get_all_companies, 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.10/setup.cfg

@@ -0,0 +1,2 @@
+[metadata]
+url = https://github.com/EarningsCall/earningscall-python

earningscall-0.0.8/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.8/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.8 → earningscall-0.0.10}/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