ResultAthle is a project aimed at making statistical tools more accessible at the amateur level in athletics. It addresses the challenges of data manipulation and the lack of accessible descriptive statistics at the club, race, or individual level.
To install the necessary dependencies, run the following command:
pip install -e ".[dev]"To retrieve competition results from a running competition on the bases.athle results site, you can use the resultathle package:
from src.resultathle.scraper import scrape_competition
header, data = scrape_competition(url, num_pages)Where url is the bases.athle URL of the competition to scrape and num_pages is the number of result pages you want to scrape.
You can also use the CLI:
python -m src.resultathle.cli <url> <num_pages> --out results.csv --json results.json --site-dir siteThe optional --site-dir renders a static index.html using the packaged template, which you can serve via any static host (including GitHub Pages).
This repository ships with a workflow that builds and deploys a static site to GitHub Pages on each push to main. Configure repository variables COMP_URL and COMP_PAGES to control which competition is scraped at deploy time. The build gracefully falls back to an empty page if scraping fails.
We are continuously working to improve ResultAthle and add new features. Here are some of the features that are currently under development:
-
WebApp: we are developing a web application version of ResultAthle. This webapp will provide users with the flexibility to access and analyze race results from bases.athle.
-
Advanced Scraping Functions: We are in the process of enhancing our web scraping capabilities to provide a more robust and sophisticated data extraction process. This will allow us to gather more detailed and comprehensive data from athletics competitions.
-
Visualization: We are working on new visualization features that will allow users to better understand and interpret the running performance. This includes various types of charts and graphs.
-
Performance Analysis: We are developing new features for analyzing athletic performance. This will include statistical analysis and machine learning algorithms to identify patterns and trends in the data.
Stay tuned for these exciting new features!
ResultAthle is licensed under the MIT License. This means you are free to use, modify, and distribute the project, as long as you include the original copyright and license notice in any copy of the software/source.
For more information on the MIT License, see the LICENSE file in this repository or visit MIT License.