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.
Package:
- Install package from official PyPi:
pip3 install earnings- Import package in your project code
example.py:
from earnings import *
def main(...) -> None:
# Insert your logic
if __name__ == "__main__":
main()- Execute the sample script:
python3 example.pySource
- Clone the repository from GitHub:
git clone https://github.com/lcsrodriguez/earnings.git
cd earnings/- Build virtual env and install dependencies
python3 -m venv venv
source ./venv/bin/activate
pip3 install -r requirements.txtSee ROADMAP.md file.
./
├── 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
- 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}
}