earningscall 0.0.23__tar.gz → 0.0.25__tar.gz

{earningscall-0.0.23 → earningscall-0.0.25}/CHANGELOG.md

@@ -1,3 +1,15 @@
+# Changelog
+
+## Release `0.0.25` - 2024-12-15
+
+* Bump version for PyPI release (no changes to the code).
+
+## Release `0.0.24` - 2024-12-15
+
+* Remove extraneous debug logging.
+* Add CBOE exchange to the list of exchanges.
+* Support env variable "EARNINGSCALL_API_KEY" for key.
+
 ## Release `0.0.23` - 2024-11-24
 
 * Allow `None` for optional fields in SpeakerInfo data structure.

{earningscall-0.0.23 → earningscall-0.0.25}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: earningscall
-Version: 0.0.23
+Version: 0.0.25
 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
@@ -30,6 +30,7 @@ License: MIT License
         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
 Keywords: earning call app,earnings call,earnings call api,earnings call app,earnings call transcript api,earnings call transcripts,earnings call transcripts api,earnings calls,earnings transcript api,listen to earnings calls,transcripts,where to listen to earnings calls
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -55,6 +56,9 @@ Description-Content-Type: text/markdown
 [![Coverage Status](https://coveralls.io/repos/github/EarningsCall/earningscall-python/badge.svg?branch=master)](https://coveralls.io/github/EarningsCall/earningscall-python?branch=master)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/earningscall?color=blue)](https://pypi.org/project/earningscall/)
 
+[![Python](https://img.shields.io/badge/Python-14354C?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)
+
+
 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
@@ -272,13 +276,13 @@ 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"
+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"
+export EARNINGSCALL_API_KEY="YOUR-SECRET-API-KEY-GOES-HERE"
 python your-python-script.py
 ```
 

{earningscall-0.0.23 → earningscall-0.0.25}/README.md

@@ -5,6 +5,9 @@
 [![Coverage Status](https://coveralls.io/repos/github/EarningsCall/earningscall-python/badge.svg?branch=master)](https://coveralls.io/github/EarningsCall/earningscall-python?branch=master)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/earningscall?color=blue)](https://pypi.org/project/earningscall/)
 
+[![Python](https://img.shields.io/badge/Python-14354C?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)
+
+
 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
@@ -222,13 +225,13 @@ 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"
+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"
+export EARNINGSCALL_API_KEY="YOUR-SECRET-API-KEY-GOES-HERE"
 python your-python-script.py
 ```
 

{earningscall-0.0.23 → earningscall-0.0.25}/TODO.md

@@ -1,10 +1,14 @@
 
 # ToDos
 
+* Add optional argument to `get_company` to specify the exchange
 * Add ability to retrieve advanced transcript data
 * Raise helpful error if the user tries to make a call that the current plan doesn't support
+* Add streaming support for Audio Data.
+* Verify changing API keys invalidates the cache
 
 
 # Considerations
 
+* Consider removing all debug logging.
 * Consider implementing @dataclass and @dataclass_json from scratch to avoid third-party dependency

{earningscall-0.0.23 → earningscall-0.0.25}/earningscall/api.py

@@ -19,7 +19,13 @@ API_BASE = f"https://v2.api.{DOMAIN}"
 def get_api_key():
     if earningscall.api_key:
         return earningscall.api_key
-    return os.environ.get("ECALL_API_KEY", "demo")
+    e_call_key = os.environ.get("ECALL_API_KEY")
+    earnings_call_key = os.environ.get("EARNINGSCALL_API_KEY")
+    if e_call_key:
+        return e_call_key
+    if earnings_call_key:
+        return earnings_call_key
+    return "demo"
 
 
 def api_key_param():
@@ -99,9 +105,7 @@ def do_get(
 
 
 def get_events(exchange: str, symbol: str):
-    log.debug(f"get_events exchange: {exchange} symbol: {symbol}")
     params = {
-        **api_key_param(),
         "exchange": exchange,
         "symbol": symbol,
     }
@@ -129,9 +133,7 @@ def get_transcript(
 
     :return: The transcript for the given exchange, symbol, year, and quarter.
     """
-    log.debug(f"get_transcript exchange: {exchange} symbol: {symbol} year: {year} quarter: {quarter} level: {level}")
     params = {
-        **api_key_param(),
         "exchange": exchange,
         "symbol": symbol,
         "year": str(year),
@@ -144,7 +146,6 @@ def get_transcript(
 
 
 def get_symbols_v2():
-    log.debug("get_symbols_v2")
     response = do_get("symbols-v2.txt", use_cache=True)
     if response.status_code != 200:
         return None
@@ -152,7 +153,6 @@ def get_symbols_v2():
 
 
 def get_sp500_companies_txt_file():
-    log.debug("get_sp500_companies_txt_file")
     response = do_get("symbols/sp500.txt", use_cache=True)
     if response.status_code != 200:
         return None
@@ -178,7 +178,6 @@ def download_audio_file(
     :rtype Optional[str]: The filename of the downloaded audio file.
     """
     params = {
-        **api_key_param(),
         "exchange": exchange,
         "symbol": symbol,
         "year": str(year),

{earningscall-0.0.23 → earningscall-0.0.25}/earningscall/company.py

@@ -15,6 +15,8 @@ log = logging.getLogger(__file__)
 class Company:
     """
     A class representing a company.
+
+    Can be used to retrieve events, transcripts, and audio files.
     """
 
     company_info: CompanyInfo
@@ -129,7 +131,6 @@ class Company:
 
         :return: The audio for the given year and quarter.
         """
-        log.info(f"Downloading audio file for {self.company_info.symbol} {event}")
         if not self.company_info.exchange or not self.company_info.symbol:
             return None
         if (not year or not quarter) and event:

{earningscall-0.0.23 → earningscall-0.0.25}/earningscall/exports.py

@@ -5,19 +5,37 @@ from earningscall.company import Company
 from earningscall.symbols import get_symbols
 
 
-def get_company(symbol: str) -> Optional[Company]:
-    company_info = get_symbols().lookup_company(symbol)
+def get_company(symbol: str, exchange: Optional[str] = None) -> Optional[Company]:
+    """
+    Get a company by symbol and optionally an exchange.
+
+    :param str symbol: The symbol to get the company for.
+    :param Optional[str] exchange: The exchange to get the company for.
+
+    :return: The company for the given symbol and exchange.
+    """
+    company_info = get_symbols().lookup_company(symbol=symbol, exchange=exchange)
     if company_info:
         return Company(company_info=company_info)
     return None
 
 
 def get_all_companies() -> Iterator[Company]:
+    """
+    Get all companies.
+
+    :return: An iterator of all companies that is available to the current API plan.
+    """
     for company_info in get_symbols().get_all():
         yield Company(company_info=company_info)
 
 
 def get_sp500_companies() -> Iterator[Company]:
+    """
+    Get all S&P 500 companies.
+
+    :return: An iterator of all S&P 500 companies that is available to the current API plan.
+    """
     resp = get_sp500_companies_txt_file()
     if not resp:
         return

{earningscall-0.0.23 → earningscall-0.0.25}/earningscall/symbols.py

@@ -8,7 +8,7 @@ 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
-EXCHANGES_IN_ORDER = ["NYSE", "NASDAQ", "AMEX", "TSX", "TSXV", "OTC", "LSE"]
+EXCHANGES_IN_ORDER = ["NYSE", "NASDAQ", "AMEX", "TSX", "TSXV", "OTC", "LSE", "CBOE"]
 
 log = logging.getLogger(__file__)
 
@@ -98,12 +98,12 @@ class Symbols:
         self.by_exchange_and_sym = {}
 
     def add(self, _sym: CompanyInfo):
-        size_before = len(self.by_exchange_and_sym)
+        # size_before = len(self.by_exchange_and_sym)
         self.exchanges.add(_sym.exchange)
         self.by_name[_sym.name].add(_sym)
         self.by_exchange_and_sym[f"{_sym.exchange}_{_sym.symbol}"] = _sym
-        if len(self.by_exchange_and_sym) == size_before:
-            log.debug(f"Duplicate: {_sym}")
+        # if len(self.by_exchange_and_sym) == size_before:
+        #     log.debug(f"Duplicate: {_sym}")
 
     def get_all(self) -> Iterator[CompanyInfo]:
         for _exchange_symbol, _symbol in self.by_exchange_and_sym.items():
@@ -115,7 +115,9 @@ class Symbols:
     def get_exchange_symbol(self, exchange_symbol: str) -> CompanyInfo:
         return self.by_exchange_and_sym[exchange_symbol]
 
-    def lookup_company(self, symbol: str) -> Optional[CompanyInfo]:
+    def lookup_company(self, symbol: str, exchange: Optional[str] = None) -> Optional[CompanyInfo]:
+        if exchange:
+            return self.get(exchange, symbol.upper())
         for exchange in EXCHANGES_IN_ORDER:
             try:
                 _symbol = self.get(exchange, symbol.upper())

{earningscall-0.0.23 → earningscall-0.0.25}/pyproject.toml

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