| Name | earnings JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | https://github.com/lcsrodriguez/earnings |
| Summary | Equity earnings Python package (confirmed calendar, news articles, earnings transcripts, ...) |
| upload_time | 2023-12-10 21:22:24 |
| maintainer | |
| docs_url | None |
| author | Lucas RODRIGUEZ |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Earnings Python package
<img src="https://img.shields.io/static/v1?label=Languages&message=Python&color=ff0000"/> <img src="https://img.shields.io/static/v1?label=Restriction&message=NO&color=26c601"/>   [](https://github.com/psf/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.
* [Overview](#overview)
* [Getting started](#getting-started)
* [Roadmap](#roadmap)
* [Project architecture](#project-architecture)
* [License & Credits](#license--credits)
## 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/
```
2. Build virtual env and install dependencies
```shell
python3 -m venv venv
source ./venv/bin/activate
pip3 install -r requirements.txt
```
## Roadmap
See [ROADMAP.md](docs/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](https://lcsrodriguez.github.io)** (Maintainer & Developer)
The [LICENSE](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}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/lcsrodriguez/earnings",
"name": "earnings",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "",
"author": "Lucas RODRIGUEZ",
"author_email": "lcsrodriguez@pm.me",
"download_url": "https://files.pythonhosted.org/packages/e0/30/e924bfdeaf89414db06568c29bb782c6c2ef6a97f3683aed34661040b05a/earnings-1.1.0.tar.gz",
"platform": null,
"description": "# Earnings Python package\n\n<img src=\"https://img.shields.io/static/v1?label=Languages&message=Python&color=ff0000\"/> <img src=\"https://img.shields.io/static/v1?label=Restriction&message=NO&color=26c601\"/>   [](https://github.com/psf/black) \n\n\n## Overview\n\n**`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.\n\n**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.\n\n* [Overview](#overview)\n* [Getting started](#getting-started)\n* [Roadmap](#roadmap)\n* [Project architecture](#project-architecture)\n* [License & Credits](#license--credits)\n\n## Getting started\n\n**Package**:\n1. Install package from official PyPi:\n```shell\npip3 install earnings\n```\n2. Import package in your project code `example.py`:\n```python\nfrom earnings import *\n\ndef main(...) -> None:\n # Insert your logic\n\nif __name__ == \"__main__\":\n main()\n```\n3. Execute the sample script:\n```shell\npython3 example.py\n```\n\n**Source**\n1. Clone the repository from GitHub:\n```shell\ngit clone https://github.com/lcsrodriguez/earnings.git\ncd earnings/\n```\n\n2. Build virtual env and install dependencies\n```shell\npython3 -m venv venv\nsource ./venv/bin/activate\npip3 install -r requirements.txt\n```\n\n## Roadmap\n\nSee [ROADMAP.md](docs/ROADMAP.md) file.\n\n## Project architecture\n\n```\n./\n\u251c\u2500\u2500 AUTHORS\n\u251c\u2500\u2500 CITATION.cff\n\u251c\u2500\u2500 Dockerfile\n\u251c\u2500\u2500 LICENSE\n\u251c\u2500\u2500 Makefile\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 chver.sh\n\u251c\u2500\u2500 docs/\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 README.md\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 ROADMAP.md\n\u251c\u2500\u2500 earnings/\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 constants.py\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 main.py\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 utils.py\n\u251c\u2500\u2500 examples/\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 main.py\n\u251c\u2500\u2500 out/\n\u251c\u2500\u2500 portfolios/\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 template.pff\n\u251c\u2500\u2500 requirements.txt\n\u2514\u2500\u2500 setup.py\n```\n\n## License & Credits\n\n- **[Lucas RODRIGUEZ](https://lcsrodriguez.github.io)** (Maintainer & Developer)\n\nThe [LICENSE](LICENSE) file contains the full license details.\n\n\nIf you are using this package for research purposes, you can quote it as shown below:\n\n```shell\n@software{RODRIGUEZ_PyEarnings_2023,\nauthor = {RODRIGUEZ, Lucas},\nmonth = dec,\ntitle = {{earnings}},\nurl = {https://github.com/lcsrodriguez/earnings},\nversion = {1.1.0},\nyear = {2023}\n}\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Equity earnings Python package (confirmed calendar, news articles, earnings transcripts, ...)",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/lcsrodriguez/earnings"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c28bd62c1439c1f0ae63d0d1969cb88463eb1d93118a0fa895f707ca06342d4f",
"md5": "9e32e740cee2295ef8d359347355034e",
"sha256": "47b95399d94b1cc92721e19711f0b8ede9509e271df490a400cad70166b6bf98"
},
"downloads": -1,
"filename": "earnings-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e32e740cee2295ef8d359347355034e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7747,
"upload_time": "2023-12-10T21:22:22",
"upload_time_iso_8601": "2023-12-10T21:22:22.098028Z",
"url": "https://files.pythonhosted.org/packages/c2/8b/d62c1439c1f0ae63d0d1969cb88463eb1d93118a0fa895f707ca06342d4f/earnings-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e030e924bfdeaf89414db06568c29bb782c6c2ef6a97f3683aed34661040b05a",
"md5": "40b1331fadff4514c1d21cbe23b60f78",
"sha256": "db4a6abe48770081d64f2f49ef90d0da6dd97739aef67a6b96c657c978ac5a23"
},
"downloads": -1,
"filename": "earnings-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "40b1331fadff4514c1d21cbe23b60f78",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 6904,
"upload_time": "2023-12-10T21:22:24",
"upload_time_iso_8601": "2023-12-10T21:22:24.056963Z",
"url": "https://files.pythonhosted.org/packages/e0/30/e924bfdeaf89414db06568c29bb782c6c2ef6a97f3683aed34661040b05a/earnings-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-10 21:22:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lcsrodriguez",
"github_project": "earnings",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "earnings"
}
