earnings
Equity earnings Python package (confirmed calendar, news articles, earnings transcripts, ...)
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.0%) to scientific vocabulary
Keywords
Repository
Equity earnings Python package (confirmed calendar, news articles, earnings transcripts, ...)
Basic Info
- Host: GitHub
- Owner: lcsrodriguez
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://pypi.org/project/earnings/
- Size: 141 KB
Statistics
- Stars: 13
- Watchers: 2
- Forks: 5
- Open Issues: 1
- Releases: 5
Topics
Metadata Files
README.md
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.
Getting started
Package:
1. Install package from official PyPi:
shell
pip3 install earnings
2. Import package in your project code example.py:
```python
from earnings import *
def main(...) -> None: # Insert your logic
if name == "main":
main()
3. Execute the sample script:
shell
python3 example.py
```
Source
1. Clone the repository from GitHub:
shell
git clone https://github.com/lcsrodriguez/earnings.git
cd earnings/
- Build virtual env and install dependencies
shell 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:
shell
@software{RODRIGUEZ_PyEarnings_2023,
author = {RODRIGUEZ, Lucas},
month = dec,
title = {{earnings}},
url = {https://github.com/lcsrodriguez/earnings},
version = {1.1.0},
year = {2023}
}
Owner
- Name: Lucas RODRIGUEZ
- Login: lcsrodriguez
- Kind: user
- Location: Paris, France
- Company: Paris-Saclay Univ., ENSIIE Paris & @unibo
- Website: lcsrodriguez.github.io
- Repositories: 4
- Profile: https://github.com/lcsrodriguez
Engineering student in CS, Applied Mathematics & Quantitative finance. C++ developer
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this package, please cite it as below." authors: - family-names: "RODRIGUEZ" given-names: "Lucas" url: "https://lcsrodriguez.github.io" title: "earnings" version: 1.1.0 date-released: 2023-12-10 url: "https://github.com/lcsrodriguez/earnings"
GitHub Events
Total
- Watch event: 8
- Fork event: 3
Last Year
- Watch event: 8
- Fork event: 3
Dependencies
- actions/checkout v3 composite
- github/codeql-action/analyze v2 composite
- github/codeql-action/autobuild v2 composite
- github/codeql-action/init v2 composite
- python 3.10.6-slim-buster build
- pandas ==2.1.3
- requests ==2.31.0