Skip to content

Commit

Permalink
Updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
lcsrodriguez committed Dec 25, 2023
1 parent e363811 commit 1b51cd6
Showing 1 changed file with 21 additions and 15 deletions.
36 changes: 21 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,35 @@

****

*Disclaimer*:
- Data scraped and processed from external sources: **[FxStreet](https://www.fxstreet.com/economic-calendar)** website.
- Data provided **AS IS** for information purpose only.

**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 Calendar
from ecocal import *
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()
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`
Expand Down Expand Up @@ -82,6 +86,8 @@
└── requirements.txt
```
## License
## License & Credits
- **[Lucas RODRIGUEZ](https://lcsrodriguez.github.io)**
[MIT](LICENSE)

0 comments on commit 1b51cd6

Please sign in to comment.