Earnings Python package

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.

• Overview
• Getting started
• Roadmap
• Project architecture
• License & Credits

Getting started

Package:

1. Install package from official PyPi:

pip3 install earnings

2. Import package in your project code example.py:

from earnings import *

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

if __name__ == "__main__":
    main()

3. Execute the sample script:

python3 example.py

Source

1. Clone the repository from GitHub:

git clone https://github.com/lcsrodriguez/earnings.git
cd earnings/

2. 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

• Lucas RODRIGUEZ (Maintainer & Developer)

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}
}