https://github.com/abbasi0abolfazl/forexfactory_calender
Python script to fetch and process Forex events from ForexFactory
https://github.com/abbasi0abolfazl/forexfactory_calender
algo-trading forex forex-trading python python-3 python3 trading
Last synced: 8 months ago
JSON representation
Python script to fetch and process Forex events from ForexFactory
- Host: GitHub
- URL: https://github.com/abbasi0abolfazl/forexfactory_calender
- Owner: abbasi0abolfazl
- License: apache-2.0
- Created: 2025-02-12T19:36:59.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-02-20T09:31:39.000Z (8 months ago)
- Last Synced: 2025-02-20T10:31:27.999Z (8 months ago)
- Topics: algo-trading, forex, forex-trading, python, python-3, python3, trading
- Language: Python
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Forex Events Scheduler
This repository contains a Python script that fetches and processes Forex events from [ForexFactory's](https://www.forexfactory.com/) weekly calendar. The script is designed to run periodically, saving Forex events to structured files for easy analysis and tracking. It supports filtering events by country, title, and impact, and allows users to save the output in either JSON or TXT format.
## Features
- **Automated Fetching**: Fetches Forex events from ForexFactory's weekly calendar (XML format) every hour.
- **Event Parsing**: Extracts key details for each event, including title, country, date, time, impact, forecast, previous value, and URL.
- **Custom Filters**: Filter events by:
- **Country** (e.g., USD, EUR)
- **Title** (case-insensitive search)
- **Impact** (e.g., High, Medium, Low)
- **Flexible Output Formats**: Save events in:
- **JSON**: Structured and machine-readable format.
- **TXT**: Human-readable, formatted text files.
- **Custom File Names**: Specify a custom base name for output files.
- **Scheduling**: Automatically runs the script every hour using the `schedule` library.
## Prerequisites
- Python 3.x
## Installation
1. Clone the repository:
```sh
git clone https://github.com/abbasi0abolfazl/forexfactory_calender.git
cd forexfactory_calender
```
2. Create a virtual environment and activate it:
```sh
python -m venv env
source env/bin/activate # On Windows, use `env\Scripts\activate`
```
3. Install the required packages:
```sh
pip install -r requirements.txt
```
## Usage
Run the script with the following command:
```sh
python forex_events_scheduler.py
```
### Command-Line Options
| Option | Description |
|------------------|-----------------------------------------------------------------------------|
| `--schedule` | Schedule the script to run every hour. |
| `--country` | Filter events by country (e.g., `USD`, `EUR`). |
| `--title` | Filter events by title (case-insensitive). |
| `--impact` | Filter events by impact (e.g., `High`, `Medium`, `Low`). |
| `--save-format` | Save format: `json` or `txt` (default: `json`). |
| `--output-file` | Base name for the output file (without extension, default: `filtered_events`). |
### Examples
1. **Run Once with Default Settings**:
```sh
python forex_events_scheduler.py
```
Output files: `filtered_events.json` or `filtered_events.txt`.
2. **Filter by Country and Save as TXT**:
```sh
python forex_events_scheduler.py --country USD --save-format txt --output-file usd_events
```
Output file: `usd_events.txt`.
3. **Schedule the Script to Run Every Hour**:
```sh
python forex_events_scheduler.py --schedule
```
4. **Custom File Name and Filters**:
```sh
python forex_events_scheduler.py --country USD --impact High --output-file high_impact_usd_events
```
Output file: `high_impact_usd_events.json`.
## Running as a Background Process
To run the script as a background process, you can use `nohup` or a process manager like `systemd`:
```sh
nohup python forex_events_scheduler.py --schedule &
```
## Output Files
The script generates output files based on the provided options:
- **JSON Format**:
```json
[
{
"title": "Nonfarm Payrolls",
"country": "USD",
"date": "10-27-2023",
"time": "08:30am",
"impact": "High",
"forecast": "200K",
"previous": "187K",
"url": "https://www.forexfactory.com/event/12345"
}
]
```
- **TXT Format**:
```
Title: Nonfarm Payrolls
Country: USD
Date: 10-27-2023
Time: 08:30am
Impact: High
Forecast: 200K
Previous: 187K
URL: https://www.forexfactory.com/event/12345
----------------------------------------
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.