earningscall 0.0.4__tar.gz

earningscall-0.0.4/.github/workflows/release.yml

@@ -0,0 +1,127 @@
+# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Install Rye
+      run: |
+        curl -sSf https://rye.astral.sh/get | RYE_NO_AUTO_INSTALL=1 RYE_INSTALL_OPTION="--yes" bash
+#        $(HOME)/.rye/shims/rye pin $(PYTHON_VERSION)
+#        $(HOME)/.rye/shims/rye sync --no-lock
+    # https://rye.astral.sh/guide/publish/
+    - name: Build a binary wheel and sdist
+      run: |
+        source ~/.rye/env
+        rye sync
+        rye build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/earningscall
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v2.1.1
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes ""
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/earningscall
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/

earningscall-0.0.4/.gitignore

@@ -0,0 +1,34 @@
+# Distribution / packaging
+.DS_Store
+.Python
+.venv
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+log
+/dumps
+/bin/dumps
+/logs
+
+/dist
+*.pyc
+*.iws
+*.zip
+workspace.xml
+tasks.xml
+/.idea
+/build
+/sc.egg-info
+/packages

earningscall-0.0.4/.python-version

@@ -0,0 +1 @@
+3.12.3

earningscall-0.0.4/DEVELOPMENT.md

@@ -0,0 +1,25 @@
+# Development
+
+TODO: Add rye installation instructions.
+
+This project uses Rye: https://rye.astral.sh/
+
+
+### Saving Server-Side Responses for a Mocked Unit test
+
+You can use the following test code to save responses from the server as a .YAML file:
+
+```python
+import requests
+
+from responses import _recorder
+
+@_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.4/LICENSE

@@ -0,0 +1,21 @@
+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.

earningscall-0.0.4/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.3
+Name: earningscall
+Version: 0.0.4
+Summary: The EarningsCall Python library.
+Project-URL: Documentation, 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
+Author-email: EarningsCall <dev@earningscall.biz>
+License-File: LICENSE
+Requires-Python: >=3.8
+Requires-Dist: dataclasses-json>=0.6.4
+Requires-Dist: dataclasses>=0.6
+Requires-Dist: more-itertools>=10.0.0
+Requires-Dist: requests>=2.30.0
+Description-Content-Type: text/markdown
+
+# EarningsCall Python Library
+
+The EarningsCall Python library provides convenient access to the EarningsCall API 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.
+
+# Installation
+
+You don't need this source code unless you want to modify the package. If you just want to use the package, just run:
+
+```sh
+pip install --upgrade earningscall
+```
+
+# Requirements
+
+* Python 3.8+ (PyPI supported)
+
+
+## Get Transcript for a Single Quarter
+
+```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)
+print(f"{company} Q3 2021 Transcript Text: \"{transcript.text[:100]}...\"")
+```
+
+Output
+
+```text
+Apple Inc. Q3 2021 Transcript Text: "Good day, and welcome to the Apple Q3 FY 2021 Earnings Conference Call. Today's call is being record..."
+```
+
+
+## Get All Transcripts for a company
+
+
+```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
+    print(f"* Q{event.quarter} {event.year}")
+    if transcript:
+        print(f"  Transcript Text: \"{transcript.text[:100]}...\"")
+    else:
+        print(f"  No transcript found.")
+
+```
+
+Output
+
+```text
+Getting all transcripts for: Apple Inc...
+* Q4 2023
+  Transcript Text: "Good day and welcome to the Apple Q4 Fiscal Year 2023 earnings conference call. Today's call is bein..."
+* Q3 2023
+  Transcript Text: "Good day and welcome to the Apple Q3 Fiscal Year 2023 earnings conference call. Today's call is bein..."
+* Q2 2023
+  Transcript Text: "At this time for opening remarks and introductions, I would like to turn the call over to Suhasini T..."
+* Q1 2023
+
+  ...
+```
+
+
+
+## List All 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}")
+```

earningscall-0.0.4/README.md

@@ -0,0 +1,85 @@
+# EarningsCall Python Library
+
+The EarningsCall Python library provides convenient access to the EarningsCall API 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.
+
+# Installation
+
+You don't need this source code unless you want to modify the package. If you just want to use the package, just run:
+
+```sh
+pip install --upgrade earningscall
+```
+
+# Requirements
+
+* Python 3.8+ (PyPI supported)
+
+
+## Get Transcript for a Single Quarter
+
+```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)
+print(f"{company} Q3 2021 Transcript Text: \"{transcript.text[:100]}...\"")
+```
+
+Output
+
+```text
+Apple Inc. Q3 2021 Transcript Text: "Good day, and welcome to the Apple Q3 FY 2021 Earnings Conference Call. Today's call is being record..."
+```
+
+
+## Get All Transcripts for a company
+
+
+```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
+    print(f"* Q{event.quarter} {event.year}")
+    if transcript:
+        print(f"  Transcript Text: \"{transcript.text[:100]}...\"")
+    else:
+        print(f"  No transcript found.")
+
+```
+
+Output
+
+```text
+Getting all transcripts for: Apple Inc...
+* Q4 2023
+  Transcript Text: "Good day and welcome to the Apple Q4 Fiscal Year 2023 earnings conference call. Today's call is bein..."
+* Q3 2023
+  Transcript Text: "Good day and welcome to the Apple Q3 Fiscal Year 2023 earnings conference call. Today's call is bein..."
+* Q2 2023
+  Transcript Text: "At this time for opening remarks and introductions, I would like to turn the call over to Suhasini T..."
+* Q1 2023
+
+  ...
+```
+
+
+
+## List All 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}")
+```

earningscall-0.0.4/TODO.md

@@ -0,0 +1,5 @@
+# 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.4/earningscall/__init__.py

@@ -0,0 +1,2 @@
+from earningscall.symbols import Symbols, load_symbols
+from earningscall.exports import get_company, get_all_companies

earningscall-0.0.4/earningscall/api.py

@@ -0,0 +1,67 @@
+import logging
+import os
+from typing import Optional
+
+import requests
+
+
+log = logging.getLogger(__file__)
+
+DOMAIN = os.environ.get("ECALL_DOMAIN", "earningscall.biz")
+API_BASE = f"https://v2.api.{DOMAIN}"
+api_key: Optional[str] = None
+
+
+def get_api_key():
+    global api_key
+    if api_key is None:
+        return os.environ.get("ECALL_API_KEY", "demo")
+    return api_key
+
+
+def get_events(exchange: str,
+               symbol: str):
+
+    log.debug(f"get_events exchange: {exchange} symbol: {symbol}")
+    params = {
+        "apikey": get_api_key(),
+        "exchange": exchange,
+        "symbol": symbol,
+    }
+    response = requests.get(f"{API_BASE}/events", params=params)
+    if response.status_code != 200:
+        return None
+    return response.json()
+
+
+def get_transcript(exchange: str,
+                   symbol: str,
+                   year: int,
+                   quarter: int) -> Optional[str]:
+
+    log.debug(f"get_transcript year: {year} quarter: {quarter}")
+    params = {
+        "apikey": "demo",
+        "exchange": exchange,
+        "symbol": symbol,
+        "year": str(year),
+        "quarter": str(quarter),
+    }
+    response = requests.get(f"{API_BASE}/transcript", params=params)
+    if response.status_code != 200:
+        return None
+    return response.json()
+
+
+def get_symbols_v1():
+    response = requests.get(f"{API_BASE}/symbols.txt")
+    if response.status_code != 200:
+        return None
+    return response.text
+
+
+def get_symbols_v2():
+    response = requests.get(f"{API_BASE}/symbols-v2.txt")
+    if response.status_code != 200:
+        return None
+    return response.text

earningscall-0.0.4/earningscall/company.py

@@ -0,0 +1,51 @@
+import logging
+from typing import Optional
+
+from earningscall import api
+from earningscall.event import EarningsEvent
+from earningscall.symbols import CompanyInfo
+from earningscall.transcript import Transcript
+
+log = logging.getLogger(__file__)
+
+
+class Company:
+
+    company_info: CompanyInfo
+    name: str
+    _events: [EarningsEvent]
+
+    def __init__(self, company_info):
+        self.company_info = company_info
+        self.name = company_info.name
+        self._events = None
+
+    def __str__(self):
+        return str(self.name)
+
+    def name(self) -> str:
+        return self.company_info.name
+
+    def _get_events(self):
+        raw_response = api.get_events(self.company_info.exchange, self.company_info.symbol)
+        return [EarningsEvent.from_dict(event) for event in raw_response["events"]]
+
+    def events(self) -> [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]:
+
+        if (not year or not quarter) and event:
+            year = event.year
+            quarter = event.quarter
+        elif (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)
+        if not resp:
+            return None
+        return Transcript.from_dict(resp)

earningscall-0.0.4/earningscall/errors.py

@@ -0,0 +1,25 @@
+
+
+class BaseError(RuntimeError):
+    """
+    Base error
+    """
+
+    def __init__(self, msg=None):
+        self.msg = msg
+
+    def __str__(self):
+        if self.msg:
+            return str(self.msg)
+        return ""
+
+
+class ClientError(BaseError):
+    """
+    Used to return 4XX errors.
+    """
+    status: int = 400  # https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400
+
+
+class MissingApiKeyError(ClientError):
+    pass

earningscall-0.0.4/earningscall/event.py

@@ -0,0 +1,28 @@
+import logging
+from dataclasses import dataclass, field
+from datetime import datetime
+from typing import Optional
+
+from dataclasses_json import config
+from dataclasses_json import dataclass_json
+from marshmallow import fields
+
+log = logging.getLogger(__file__)
+
+
+@dataclass_json
+@dataclass
+class EarningsEvent:
+    """
+    EarningsEvent
+    """
+    year: int
+    quarter: int
+    conference_date: Optional[datetime] = field(
+        default=None,
+        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")
+        )
+    )

earningscall-0.0.4/earningscall/exports.py

@@ -0,0 +1,17 @@
+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_all_companies() -> [Company]:
+    for company_info in get_symbols().get_all():
+        yield Company(company_info=company_info)
+
+
+def get_sp500_companies() -> [Company]:
+    for company_info in get_symbols().get_all():
+        yield Company(company_info=company_info)