earningscall 0.0.9__py3-none-any.whl → 0.0.12__py3-none-any.whl

earningscall/__init__.py

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

earningscall/api.py

@@ -27,8 +27,7 @@ def is_demo_account():
     return get_api_key() == "demo"
 
 
-def get_events(exchange: str,
-               symbol: str):
+def get_events(exchange: str, symbol: str):
 
     log.debug(f"get_events exchange: {exchange} symbol: {symbol}")
     params = {
@@ -42,10 +41,7 @@ def get_events(exchange: str,
     return response.json()
 
 
-def get_transcript(exchange: str,
-                   symbol: str,
-                   year: int,
-                   quarter: int) -> Optional[str]:
+def get_transcript(exchange: str, symbol: str, year: int, quarter: int) -> Optional[str]:
 
     log.debug(f"get_transcript year: {year} quarter: {quarter}")
     params = {
@@ -80,3 +76,9 @@ def get_sp500_companies_txt_file():
     if response.status_code != 200:
         return None
     return response.text
+
+
+# def do_something():
+#     session = CachedSession('demo_cache', cache_control=True)
+#
+#     # CachedSession()

earningscall/company.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Optional
+from typing import Optional, List
 
 from earningscall import api
 from earningscall.event import EarningsEvent
@@ -12,8 +12,8 @@ log = logging.getLogger(__file__)
 class Company:
 
     company_info: CompanyInfo
-    name: str
-    _events: [EarningsEvent]
+    name: Optional[str]
+    _events: Optional[List[EarningsEvent]]
 
     def __init__(self, company_info: CompanyInfo):
         if not company_info:
@@ -25,31 +25,31 @@ class Company:
     def __str__(self):
         return str(self.name)
 
-    def name(self) -> str:
-        return self.company_info.name
-
-    def _get_events(self):
+    def _get_events(self) -> List[EarningsEvent]:
+        if not self.company_info.exchange or not self.company_info.symbol:
+            return []
         raw_response = api.get_events(self.company_info.exchange, self.company_info.symbol)
         if not raw_response:
             return []
-        return [EarningsEvent.from_dict(event) for event in raw_response["events"]]
+        return [EarningsEvent.from_dict(event) for event in raw_response["events"]]  # type: ignore
 
-    def events(self) -> [EarningsEvent]:
+    def events(self) -> List[EarningsEvent]:
         if not self._events:
             self._events = self._get_events()
         return self._events
 
-    def get_transcript(self,
-                       year: Optional[int] = None,
-                       quarter: Optional[int] = None,
-                       event: Optional[EarningsEvent] = None) -> Optional[Transcript]:
+    def get_transcript(
+        self, year: Optional[int] = None, quarter: Optional[int] = None, event: Optional[EarningsEvent] = None
+    ) -> Optional[Transcript]:
 
+        if not self.company_info.exchange or not self.company_info.symbol:
+            return None
         if (not year or not quarter) and event:
             year = event.year
             quarter = event.quarter
-        elif (not year or not quarter) and not event:
+        if (not year or not quarter) and not event:
             raise ValueError("Must specify either event or year and quarter")
-        resp = api.get_transcript(self.company_info.exchange, self.company_info.symbol, year, quarter)
+        resp = api.get_transcript(self.company_info.exchange, self.company_info.symbol, year, quarter)  # type: ignore
         if not resp:
             return None
-        return Transcript.from_dict(resp)
+        return Transcript.from_dict(resp)  # type: ignore

earningscall/errors.py

@@ -1,5 +1,3 @@
-
-
 class BaseError(RuntimeError):
     """
     Base error
@@ -18,6 +16,7 @@ class ClientError(BaseError):
     """
     Used to return 4XX errors.
     """
+
     status: int = 400  # https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400
 
 

earningscall/event.py

@@ -16,6 +16,7 @@ class EarningsEvent:
     """
     EarningsEvent
     """
+
     year: int
     quarter: int
     conference_date: Optional[datetime] = field(
@@ -23,6 +24,6 @@ class EarningsEvent:
         metadata=config(
             encoder=lambda date: date.isoformat() if date else None,
             decoder=lambda date: datetime.fromisoformat(date) if date else None,
-            mm_field=fields.DateTime(format="iso")
-        )
+            mm_field=fields.DateTime(format="iso"),
+        ),
     )

earningscall/exports.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Optional, Iterator
 
 from earningscall.api import get_sp500_companies_txt_file
 from earningscall.company import Company
@@ -12,15 +12,15 @@ def get_company(symbol: str) -> Optional[Company]:
     return None
 
 
-def get_all_companies() -> [Company]:
+def get_all_companies() -> Iterator[Company]:
     for company_info in get_symbols().get_all():
         yield Company(company_info=company_info)
 
 
-def get_sp500_companies() -> [Company]:
+def get_sp500_companies() -> Iterator[Company]:
     resp = get_sp500_companies_txt_file()
     if not resp:
-        return []
+        return
     for ticker_symbol in resp.split("\n"):
         company_info = get_symbols().lookup_company(ticker_symbol)
         if company_info:

earningscall/sectors.py

@@ -1,6 +1,6 @@
 import json
 import logging
-
+from typing import Optional
 
 log = logging.getLogger(__file__)
 sectors_file_name = "sectors.json"
@@ -17,7 +17,7 @@ SECTORS_IN_ORDER = [
     'Industrials',
     'Real Estate',
     'Technology',
-    'Utilities'
+    'Utilities',
 ]
 
 
@@ -166,7 +166,7 @@ INDUSTRIES_IN_ORDER = [
     'Utilities - Regulated Gas',
     'Utilities - Regulated Water',
     'Utilities - Renewable',
-    'Waste Management'
+    'Waste Management',
 ]
 
 
@@ -198,9 +198,7 @@ def industry_to_index(_industry: str) -> int:
 
 class Sectors:
 
-    def __init__(self,
-                 sectors: set = None,
-                 industries: set = None):
+    def __init__(self, sectors: Optional[set] = None, industries: Optional[set] = None):
         if sectors:
             self.sectors = sectors
         else:
@@ -218,7 +216,7 @@ class Sectors:
         if industry is not None:
             self.industries.add(industry)
 
-    def to_dicts(self) -> {}:
+    def to_dicts(self) -> dict:
         return {
             "sectors": list(self.sectors),
             "industries": list(self.industries),
@@ -231,4 +229,3 @@ class Sectors:
     def from_json(json_str):
         data = json.loads(json_str)
         return Sectors(set(data["sectors"]), set(data["industries"]))
-

earningscall/symbols.py

@@ -2,7 +2,7 @@ import json
 import logging
 import re
 from collections import defaultdict
-from typing import Optional
+from typing import Optional, Iterator, List
 
 from earningscall.api import get_symbols_v2, is_demo_account
 from earningscall.errors import InsufficientApiAccessError
@@ -14,7 +14,9 @@ EXCHANGES_IN_ORDER = ["NYSE", "NASDAQ", "AMEX", "TSX", "TSXV", "OTC"]
 log = logging.getLogger(__file__)
 
 
-def exchange_to_index(_exchange: str) -> int:
+def exchange_to_index(_exchange: Optional[str]) -> int:
+    if not _exchange:
+        return -1
     try:
         return EXCHANGES_IN_ORDER.index(_exchange)
     except ValueError:
@@ -110,7 +112,7 @@ class Symbols:
         if len(self.by_exchange_and_sym) == size_before:
             log.debug(f"Duplicate: {_sym}")
 
-    def get_all(self) -> [CompanyInfo]:
+    def get_all(self) -> Iterator[CompanyInfo]:
         for _exchange_symbol, _symbol in self.by_exchange_and_sym.items():
             yield _symbol
 
@@ -129,8 +131,10 @@ class Symbols:
             except KeyError:
                 pass
         if is_demo_account():
-            raise InsufficientApiAccessError(f"\"{symbol}\" requires an API Key for access.  To get your API Key,"
-                                             f" see: 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):
@@ -142,11 +146,13 @@ class Symbols:
     def remove_keys(symbol_as_dict: dict, keys_to_remove: set):
         return {key: value for key, value in symbol_as_dict.items() if key not in keys_to_remove}
 
-    def without_security_names(self) -> [dict]:
-        return [self.remove_keys(symbol_as_dict, {"security_name", "sector", "industry"})
-                for symbol_as_dict in self.to_dicts()]
+    def without_security_names(self) -> List[dict]:
+        return [
+            self.remove_keys(symbol_as_dict, {"security_name", "sector", "industry"})
+            for symbol_as_dict in self.to_dicts()
+        ]
 
-    def to_dicts(self) -> [dict]:
+    def to_dicts(self) -> List[dict]:
         return [__symbol.__dict__ for __symbol in self.get_all()]
 
     def to_json(self, remove_security_names: bool = False) -> str:
@@ -154,9 +160,14 @@ class Symbols:
             return json.dumps(self.without_security_names())
         return json.dumps(self.to_dicts())
 
-    def to_json_v2(self) -> str:
-        return json.dumps([[exchange_to_index(__symbol.exchange), __symbol.company_info, __symbol.name]
-                           for __symbol in self.get_all()])
+    # TODO: Test this
+    # def to_json_v2(self) -> str:
+    #     return json.dumps(
+    #         [
+    #             [exchange_to_index(__symbol.exchange), __symbol.company_info, __symbol.name]
+    #             for __symbol in self.get_all()
+    #         ]
+    #     )
 
     def to_txt(self) -> str:
         exchange_symbol_names = [__symbol.to_txt_row() for __symbol in self.get_all()]
@@ -195,13 +206,15 @@ class Symbols:
         __symbols = Symbols()
         for line in txt_str.split("\n"):
             _exchange_index, _symbol, _name, _sector_index, _industry_index = line.split("\t")
-            __symbols.add(CompanyInfo(
-                exchange=index_to_exchange(int(_exchange_index)),
-                symbol=_symbol,
-                name=_name,
-                sector=index_to_sector(int(_sector_index)),
-                industry=index_to_industry(int(_industry_index)),
-            ))
+            __symbols.add(
+                CompanyInfo(
+                    exchange=index_to_exchange(int(_exchange_index)),
+                    symbol=_symbol,
+                    name=_name,
+                    sector=index_to_sector(int(_sector_index)),
+                    industry=index_to_industry(int(_industry_index)),
+                )
+            )
         return __symbols
 
     @staticmethod

{earningscall-0.0.9.dist-info → earningscall-0.0.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: earningscall
-Version: 0.0.9
+Version: 0.0.12
 Summary: The EarningsCall Python library.
 Project-URL: Homepage, https://earningscall.biz
 Project-URL: Documentation, https://github.com/EarningsCall/earningscall-python
@@ -9,10 +9,32 @@ 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
 Requires-Dist: dataclasses>=0.6
+Requires-Dist: requests-cache>=1.2.0
 Requires-Dist: requests>=2.30.0
 Description-Content-Type: text/markdown
 
@@ -92,8 +114,6 @@ Getting all transcripts for: Apple Inc...
   ...
 ```
 
-
-
 ## List All Companies
 
 ```python
@@ -103,15 +123,6 @@ 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.
@@ -119,10 +130,8 @@ To gain access to 5,000+ companies please [signup here](https://earningscall.biz
 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"
 ```
 
@@ -132,3 +141,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.12.dist-info/RECORD

@@ -0,0 +1,14 @@
+earningscall/__init__.py,sha256=NX9f2et-q3p8BRGvJB0enRSLlSGecSAwspPxhDsL95Y,298
+earningscall/api.py,sha256=eK43JazoBNI9YF0OMi5c0DrYv0tVzyOy2ycNyX63y8s,2000
+earningscall/company.py,sha256=ZNF75htXg37oXtNzwrHH8DoTdyFJ3PBB9qSNBp_vo8c,1943
+earningscall/errors.py,sha256=EA-d6qIYgQs9csp8JptQiAaYoM0M9HhCGJgKA9GAWPg,440
+earningscall/event.py,sha256=O7KAE2wO3mBhlEWIFA1choMNGRthYd0gBIvVQOmVALs,692
+earningscall/exports.py,sha256=i9UWHY6Lq1OzZTZX_1SdNzrNd_PSlPwpB337lGMK4oM,837
+earningscall/sectors.py,sha256=9kAwTtJEDbWah6lz5io88qRwvCtmGgjQ-MU7rayTmVI,5962
+earningscall/symbols.py,sha256=EXSPUMr50zZz-Cw9CimrRbVd7F71PB9McgsFC7yJ5S4,7980
+earningscall/transcript.py,sha256=rLH2bGrrgUmS8XZGAPUP7msiIcL7f4ABmbnVJWXI28c,329
+earningscall/utils.py,sha256=Qx8KhlumUdzyBSZRKMS6vpWlb8MGZpLKA4OffJaMdCE,1032
+earningscall-0.0.12.dist-info/METADATA,sha256=Br6DJz0J0ZVy4FrY6qkSYcFoze_unf2ooht9v7D__UQ,5714
+earningscall-0.0.12.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
+earningscall-0.0.12.dist-info/licenses/LICENSE,sha256=ktEB_UcRMg2cQlX9wiDs544xWncWizwS9mEZuGsCLrM,1069
+earningscall-0.0.12.dist-info/RECORD,,

earningscall-0.0.9.dist-info/RECORD

@@ -1,14 +0,0 @@
-earningscall/__init__.py,sha256=cIuYT8auBFMdNGCv6maIL8XCdv10LYEJfh590H4bk58,179
-earningscall/api.py,sha256=-nqxFGrTinCFCj8_wA-fkyrqr-WfDS50sMAh2UGdBR0,1958
-earningscall/company.py,sha256=VyiHOajDBAx-G6dgWrPBUwWKjDpBvb0moZIpULPmiKA,1765
-earningscall/errors.py,sha256=_m8CvAcyWQprdyTNzYjdoCX5nUZpEP7rG4c5-eLmxno,441
-earningscall/event.py,sha256=Gdda4829tWlrlFn38r8KOaI-IJzf-ambiNojKyr9XtY,689
-earningscall/exports.py,sha256=wA6d4-AJyT-0Wz8g_j-3rFHHhnXHx5V1GCsaPJMatFc,814
-earningscall/sectors.py,sha256=9aw14krRzdLJSTFC72Nwk3MQaXAIgkTBk5S-KTiki3U,5946
-earningscall/symbols.py,sha256=StqRc_C2hFdlhCMEKpytfUmsruCSHY0WPQQIVIejF9k,7748
-earningscall/transcript.py,sha256=rLH2bGrrgUmS8XZGAPUP7msiIcL7f4ABmbnVJWXI28c,329
-earningscall/utils.py,sha256=Qx8KhlumUdzyBSZRKMS6vpWlb8MGZpLKA4OffJaMdCE,1032
-earningscall-0.0.9.dist-info/METADATA,sha256=n5_NDlAdDDj76qwCTJbZcgPYvQ7qM-XOQ9bLVFZHe6A,4437
-earningscall-0.0.9.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-earningscall-0.0.9.dist-info/licenses/LICENSE,sha256=ktEB_UcRMg2cQlX9wiDs544xWncWizwS9mEZuGsCLrM,1069
-earningscall-0.0.9.dist-info/RECORD,,