50 lines
1.3 KiB
Markdown
50 lines
1.3 KiB
Markdown
|
# OSM Paris Event Watcher
|
||
|
|
|
||
|
|
This Python script periodically checks the OpenStreetMap Calendar API for upcoming events in Paris, particularly focused on hack weekends. If it finds any events, it sends an email notification with the event details.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
- Fetches event data from the OSM Calendar API for events located in France.
|
||
|
|
- Filters for events that are specifically in Paris.
|
||
|
|
- Sends an email notification for each event found in Paris.
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
- Python 3.8 or later.
|
||
|
|
- `requests` library.
|
||
|
|
|
||
|
|
To install the required Python library, run:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
pip install requests
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
To run the script, simply execute:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
python3 check.py
|
||
|
|
```
|
||
|
|
|
||
|
|
Make sure to run it in an environment where it has network access to both the OSM Calendar API and your SMTP server.
|
||
|
|
|
||
|
|
## 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.
|
||
|
|
|
||
|
|
These are currently set to default values and will need to be updated to reflect your actual email setup.
|
||
|
|
|
||
|
|
## Contact
|
||
|
|
|
||
|
|
For any queries or further customization, please contact:
|
||
|
|
Edward Betts <edward@4angle.com>
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
This project is licensed under the MIT License.
|