# Economic Calendar
<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)
[](https://github.com/lcsrodriguez/ecocal/actions/workflows/codeql.yml) 
## Overview
`ecocal` is a light-weight and easy-to-user Python package allowing every developer to retrieve full access to both historical and future insightful and hifhly-detailed economic calendar (worldwide scale).
****
**DISCLAIMER**:
- Data extracted from external providers. No warranty on data quality/accuracy.
- Data provided **AS IS** for information purpose only.
## Getting started
> Install from **PyPI**:
1. Install `ecocal` package
```shell
pip3 install ecocal
```
2. Execute the example code
```python
from ecocal import *
def main() -> None:
ec = Calendar(startHorizon="2023-10-26",
endHorizon="2023-11-30",
withDetails=True,
nbThreads=20,
preBuildCalendar=True,
)
print(ec)
# On-disk saving of detailed calendar
ec.saveCalendar()
if __name__ == "__main__":
main()
```
Code available using:
- `python examples/main.py`
- `jupyter-notebook examples/main.ipynb` (dynamic debugging)
> Install from **source**
1. Clone the repository:
```shell
git clone https://github.com/lcsrodriguez/ecocal.git
cd ecocal/
```
2. Create a virtual environment for **clean** environment
```shell
python3 -m venv venv
source venv/bin/activate
```
3. Install the required Python packages
```shell
pip3 install -r requirements.txt
pip3 freeze
```
4. Initiate the project
```shell
make init
```
## Project's architecture
```
./
├── CITATION.cff
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── ecocal/
│ ├── Calendar.py
│ ├── Event.py
│ ├── __init__.py
│ ├── constants.py
│ └── utils.py
├── examples/
│ ├── main.ipynb
│ └── main.py
├── requirements.txt
└── setup.py
```
## License & Credits
- **[Lucas RODRIGUEZ](https://lcsrodriguez.github.io)**
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 *(BibTeX format)*:
```shell
@software{RODRIGUEZ_ecocal_2023,
author = {RODRIGUEZ, Lucas},
month = dec,
title = {{ecocal}},
url = {https://github.com/lcsrodriguez/ecocal},
version = {1.2.1},
year = {2023}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/lcsrodriguez/ecocal",
"name": "ecocal",
"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/f1/a3/8f0e2b8661142aa3d07bb35ccab7ee7874e1bd9a431ac0caf587740341cd/ecocal-1.2.1.tar.gz",
"platform": null,
"description": "# Economic Calendar\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[](https://github.com/lcsrodriguez/ecocal/actions/workflows/codeql.yml) \n\n\n\n\n\n\n\n\n## Overview\n\n`ecocal` is a light-weight and easy-to-user Python package allowing every developer to retrieve full access to both historical and future insightful and hifhly-detailed economic calendar (worldwide scale).\n\n****\n\n**DISCLAIMER**: \n- Data extracted from external providers. No warranty on data quality/accuracy.\n- Data provided **AS IS** for information purpose only.\n\n## Getting started\n\n> Install from **PyPI**:\n1. Install `ecocal` package\n ```shell\n pip3 install ecocal\n ```\n2. Execute the example code\n ```python\n from ecocal import *\n \n \n def main() -> None:\n ec = Calendar(startHorizon=\"2023-10-26\",\n endHorizon=\"2023-11-30\",\n withDetails=True,\n nbThreads=20,\n preBuildCalendar=True,\n )\n print(ec)\n # On-disk saving of detailed calendar\n ec.saveCalendar()\n \n if __name__ == \"__main__\":\n main()\n ```\n Code available using:\n - `python examples/main.py`\n - `jupyter-notebook examples/main.ipynb` (dynamic debugging)\n\n\n> Install from **source**\n1. Clone the repository:\n ```shell\n git clone https://github.com/lcsrodriguez/ecocal.git\n cd ecocal/\n ```\n2. Create a virtual environment for **clean** environment\n ```shell\n python3 -m venv venv\n source venv/bin/activate\n ```\n3. Install the required Python packages\n ```shell\n pip3 install -r requirements.txt\n pip3 freeze\n ```\n4. Initiate the project\n ```shell\n make init\n ```\n\n## Project's architecture\n\n```\n./\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 ecocal/\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 Calendar.py\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 Event.py\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 constants.py\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 utils.py\n\u251c\u2500\u2500 examples/\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 main.ipynb\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 main.py\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)**\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 *(BibTeX format)*:\n\n```shell\n@software{RODRIGUEZ_ecocal_2023,\nauthor = {RODRIGUEZ, Lucas},\nmonth = dec,\ntitle = {{ecocal}},\nurl = {https://github.com/lcsrodriguez/ecocal},\nversion = {1.2.1},\nyear = {2023}\n}\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Worldwide economic calendar Python package (details, estimates, market news, ...)",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/lcsrodriguez/ecocal"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ed640a21149fd5da72522757a05f2e3369231ae103a751e9d9ade2f3410ae789",
"md5": "9ff6be0c50e566013b862d054b659d89",
"sha256": "55fe32e48773e4b380bbb3ac8f68670bad20f776abd9a2fd7e39e024a6d65b95"
},
"downloads": -1,
"filename": "ecocal-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ff6be0c50e566013b862d054b659d89",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7673,
"upload_time": "2023-12-25T18:18:34",
"upload_time_iso_8601": "2023-12-25T18:18:34.520007Z",
"url": "https://files.pythonhosted.org/packages/ed/64/0a21149fd5da72522757a05f2e3369231ae103a751e9d9ade2f3410ae789/ecocal-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f1a38f0e2b8661142aa3d07bb35ccab7ee7874e1bd9a431ac0caf587740341cd",
"md5": "7766cf65b129bdeba68704045c1e1f08",
"sha256": "d6dddaef186281c629d19b04059c4ecd6ddec014b57d07869a79a287da8f77c9"
},
"downloads": -1,
"filename": "ecocal-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "7766cf65b129bdeba68704045c1e1f08",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 6771,
"upload_time": "2023-12-25T18:18:36",
"upload_time_iso_8601": "2023-12-25T18:18:36.153988Z",
"url": "https://files.pythonhosted.org/packages/f1/a3/8f0e2b8661142aa3d07bb35ccab7ee7874e1bd9a431ac0caf587740341cd/ecocal-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-25 18:18:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lcsrodriguez",
"github_project": "ecocal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"2.1.4"
]
]
},
{
"name": "tqdm",
"specs": [
[
"==",
"4.66.1"
]
]
}
],
"lcname": "ecocal"
}
JSON
