Skip to main content

Equity earnings Python package (confirmed calendar, news articles, earnings transcripts, ...)

Project description

Earnings Python package

  GitHub release (latest by date) python version | 3.10+ Code style: black

Overview

earnings is a lightweight and featureful Python package tailored to retrieve insightful earnings details, allowing users to collect previous and future earnings calendars, filter by US-equity ticker, define a custom portfolio and easily integrate reliable financial data into your applications.

DISCLAIMER: Data are provided AS IS by external providers. No warranty on data quality and accuracy. Please do your own research before deploying on production.

Getting started

Package:

  1. Install package from official PyPi:
pip3 install earnings
  1. Import package in your project code example.py:
from earnings import *

def main(...) -> None:
    # Insert your logic

if __name__ == "__main__":
    main()
  1. Execute the sample script:
python3 example.py

Source

  1. Clone the repository from GitHub:
git clone https://github.com/lcsrodriguez/earnings.git
cd earnings/
  1. Build virtual env and install dependencies
python3 -m venv venv
source ./venv/bin/activate
pip3 install -r requirements.txt

Roadmap

See ROADMAP.md file.

Project architecture

./
├── AUTHORS
├── CITATION.cff
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── chver.sh
├── docs/
│   ├── README.md
│   └── ROADMAP.md
├── earnings/
│   ├── __init__.py
│   ├── constants.py
│   ├── main.py
│   └── utils.py
├── examples/
│   └── main.py
├── out/
├── portfolios/
│   └── template.pff
├── requirements.txt
└── setup.py

License & Credits

The LICENSE file contains the full license details.

If you are using this package for research purposes, you can quote it as shown below:

@software{RODRIGUEZ_PyEarnings_2023,
author = {RODRIGUEZ, Lucas},
month = dec,
title = {{earnings}},
url = {https://github.com/lcsrodriguez/earnings},
version = {1.1.0},
year = {2023}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

earnings-1.1.0.tar.gz (6.9 kB view hashes)

Uploaded Source

Built Distribution

earnings-1.1.0-py3-none-any.whl (7.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page