https://github.com/mikedbjones/maprun-results
Combine and merge results from Maprun
https://github.com/mikedbjones/maprun-results
aws-eventbridge aws-lambda ftplib maprun pandas python requests wordpress
Last synced: 6 months ago
JSON representation
Combine and merge results from Maprun
- Host: GitHub
- URL: https://github.com/mikedbjones/maprun-results
- Owner: mikedbjones
- License: mit
- Created: 2022-06-15T15:57:13.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-06-28T23:41:10.000Z (about 1 year ago)
- Last Synced: 2025-06-29T00:26:03.271Z (about 1 year ago)
- Topics: aws-eventbridge, aws-lambda, ftplib, maprun, pandas, python, requests, wordpress
- Language: Python
- Homepage: https://explorerevents.co.uk/peak-raid-maprun-2024-results/
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# maprun-results
This project automatically downloads separate results from multiple [Maprun events](https://maprunners.weebly.com/), then combines points and time scores for each competitor. It then ranks competitors by overall number of points and time taken. The combined results in CSV and HTML format are stored locally, and optionally uploaded to a website using FTP, or to a Wordpress site using `requests`. If you run, or take part in, a Maprun series of events such as the [Peak Raid Series](https://explorerevents.co.uk/), this tool can be useful in creating and viewing combined series results.
## Usage
### Local
First, configure `events_info.json`, specifying:
- `"file"`: json filename containing custom event names and results URLs (see `peak_raid_2024.json` for an example)
- `"html_name"`: name for html and csv files
- `"html_title"`: html title
- `"upload_type"`: "wordpress" or "ftp"
Ensure that, together with `events_info.json`, the events file itself (eg `peak_raid_2024.json`) is present in the local directory.
Optionally, export the following environment variables to enable FTP/Wordpress upload:
- `UPLOAD_ADDRESS` (eg "ftp.mywebsitehost.com")
- `UPLOAD_DIRECTORY` (eg "/public_html/maprun-results/")
- `UPLOAD_USERNAME`
- `UPLOAD_PASSWORD`
- `WORDPRESS_URL`
- `WORDPRESS_USERNAME`
- `WORDPRESS_PASSWORD`
In bash, this would be achieved using:
```
export UPLOAD_ADDRESS="ftp.mywebsitehost.com"
```
Repeat for the others.
Now, in a python virtual environment, run the following commands:
```
pip install -r requirements.txt
python results.py
```
This will produce CSV and HTML files locally, which will also be uploaded to the specified upload location, if specified. This script could be run on a local machine with a cron schedule if desired. Or set it to run in the cloud (see AWS Lambda example below) and forget about it :smile:!
### AWS Lambda
#### Create and upload Docker image
Run the following commands to build the Docker image and upload to AWS ECR:
```
aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin [aws-account-id].dkr.ecr.us-east-1.amazonaws.com
docker build -t maprun-results .
docker tag maprun-results:latest [aws-account-id].dkr.ecr.us-east-1.amazonaws.com/maprun-results:latest
docker push [aws-account-id].dkr.ecr.us-east-1.amazonaws.com/maprun-results:latest
```
#### Create Lambda function
- Configure an AWS Lambda function with this ECR image
- Set the environment variables
- Increase the timeout to at least 1 minute
#### Create EventBridge schedule
Finally configure an EventBridge schedule (eg once per hour), that will trigger the Lambda function. In the schedule target, copy and paste from `events_info.json`.
## Example combined results
The repository is deployed on AWS for regular updates to [Peak Raid series](https://explorerevents.co.uk/) combined results: [https://explorerevents.co.uk/peak-raid-maprun-2024-results/](https://explorerevents.co.uk/peak-raid-maprun-2024-results/).