Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

lcsrodriguez/ecocal

Open more actions menu

Repository files navigation

Economic Calendar

  GitHub release (latest by date) python version | 3.10+ Code style: black

CodeQL 

PyPI - Downloads PyPI - Format PyPI - Implementation PyPI - License PyPI - Version PyPI - Python Version

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
    pip3 install ecocal
  2. Execute the example code
    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:
    git clone https://github.com/lcsrodriguez/ecocal.git
    cd ecocal/
  2. Create a virtual environment for clean environment
    python3 -m venv venv
    source venv/bin/activate
  3. Install the required Python packages
    pip3 install -r requirements.txt
    pip3 freeze
  4. Initiate the project
    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

The 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):

@software{RODRIGUEZ_ecocal_2023,
author = {RODRIGUEZ, Lucas},
month = dec,
title = {{ecocal}},
url = {https://github.com/lcsrodriguez/ecocal},
version = {1.2.1},
year = {2023}
}
Morty Proxy This is a proxified and sanitized view of the page, visit original site.