check-osmcal-for-paris-events/README.md

# Paris OSM Event Watcher

This Python script monitors the OpenStreetMap Calendar for upcoming events in Paris and sends email alerts if any are found. It specifically checks the OSM Calendar API for any events that are scheduled to take place in Paris.

## Features

- **Event Filtering**: Filters the list of events retrieved from OSMCal to find those located in Paris.
- **Email Notifications**: Sends a detailed email notification listing the upcoming events found in Paris.

## Installation

Clone the repository to your local machine:

```bash
git clone https://git.4angle.com/edward/check-osmcal-for-paris-events
```

Ensure you have `Python 3` and `requests` library installed:

```bash
pip install requests
```

## Usage

The script can be executed manually by running:

```bash
python3 /path/to/check.py
```

However, it is intended to be run periodically as a cron job. Here's an example cron job setup that executes the script every 6 hours:

```
# Check the OpenStreetMap Calendar API for upcoming events in Paris and send an alert
0 */6 * * * /usr/bin/python3 /parth/to/check.py
```

## Configuration

You will need to configure the following variables within the script:

- `MAIL_FROM`: The email address to send from.
- `MAIL_TO`: The recipient email address.
- `SMTP_HOST`: The hostname of the SMTP server you are using to send emails.

## Support

For support, contact Edward Betts at [edward@4angle.com](mailto:edward@4angle.com).

## Contributing

Contributions to this project are welcome. Please fork the repository and submit a pull request.

## License

This project is licensed under the MIT License.