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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file earnings-1.1.0.tar.gz.

File metadata

  • Download URL: earnings-1.1.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for earnings-1.1.0.tar.gz
Algorithm Hash digest
SHA256 db4a6abe48770081d64f2f49ef90d0da6dd97739aef67a6b96c657c978ac5a23
MD5 40b1331fadff4514c1d21cbe23b60f78
BLAKE2b-256 e030e924bfdeaf89414db06568c29bb782c6c2ef6a97f3683aed34661040b05a

See more details on using hashes here.

File details

Details for the file earnings-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: earnings-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for earnings-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 47b95399d94b1cc92721e19711f0b8ede9509e271df490a400cad70166b6bf98
MD5 9e32e740cee2295ef8d359347355034e
BLAKE2b-256 c28bd62c1439c1f0ae63d0d1969cb88463eb1d93118a0fa895f707ca06342d4f

See more details on using hashes here.

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