Metadata-Version: 2.4
Name: hema_scorecard_scraper
Version: 0.1.2
Summary: A simple web scraping program to get data from HEMA Scorecard to text files for OBS to consume.
Project-URL: Homepage, https://github.com/goose-lafetra/hema_scorecard_scraper
Author-email: Goose La Fetra <gooselafetra@protonmail.com>
License-Expression: CC-BY-SA-4.0
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: prompt-toolkit
Requires-Dist: requests
Description-Content-Type: text/markdown

# HEMA Scorecard Scraper

A simple web scraping program to get data from HEMA Scorecard to text files for OBS to consume. Created for IFG's Tournament of the Roses 2026. It is not affiliated with HEMA Scorecard in any way.

### Legal Notice

By using this software you agree to only use the web scraper during events and test runs of events. There exist several safeguards to try and prevent you from spamming HEMA Scorecard with http requests, but if you modify the software, that may occur. For that reason, any modifications to this software must not poll the site more the 5 times per secound and must retain the original timeout of 8 hours or less.

Don't make me take this package offline.

*This work is licensed under* <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a><img src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" alt="" style="max-width: 1em;max-height:1em;margin-left: .2em;"><img src="https://mirrors.creativecommons.org/presskit/icons/by.svg" alt="" style="max-width: 1em;max-height:1em;margin-left: .2em;"><img src="https://mirrors.creativecommons.org/presskit/icons/sa.svg" alt="" style="max-width: 1em;max-height:1em;margin-left: .2em;">

## Installation

_This guide is for unix based systems, commands for Windows installation may vary._

1. Ensure you have Python 3 installed.

2. Run `python3 -m pip -install hema_scorecard_scraper` though a terminal.

## Usage

Once HEMA Scorecard Scraper has been installed, you can start the program from the terminal using the command `python3 -m hema_scorecard_scraper.scraper_console`.

While the scraper is running, you should have a console in the terminal that you can type commands into. Note that the scraper console is in the "stopped" position by default and you will need to run the `start` command to start fetching data. Files will be outputted into a directory named `out` located wherever you are running the program from.



## Commands

### help

Displays this list of commands.

### next

Switches the scraper to track the next match by match number. Normally this will advance to the next match in the pool, but if you are at the end of a pool, it will advance to the next pool. Also writes the data to the files immidently.

### prev

Same as the `next` command except it increments the match number down, not up.

### start

Starts running the scraper in the background. Updates every half second. The scraper is initially in the stopped position so you will have to run this command once to get things going once you have it pointed at the right match. If the program is still running 8 hours after you've started this command, it will time out run the `stop` command. This is meant to prevent someone from leaving this program running in the background by accident.

### stop

Stops the scraper running in the background.

### quit

Exits the program entirely.

### \<url\>

Sets the scraper to track a specific match. The indended use case is for you to copy the url of the match from the HEMA Scorecard site, and paste it into the console. (You do not need to type `<url>`, just enter the url itsself.)
