67 lines
1.8 KiB
Markdown
67 lines
1.8 KiB
Markdown
# OE HTML viewer
|
|
|
|
Simple Python script to serve the exported HTML results file from the SportSoftware OE application on the local network.
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Python 3.x
|
|
- pip
|
|
- virtualenv
|
|
|
|
### Installation
|
|
|
|
1. Clone the repository:
|
|
```sh
|
|
git clone <repository_url>
|
|
cd <repository_name>
|
|
```
|
|
|
|
2. Create a virtual environment:
|
|
```sh
|
|
python -m venv .venv
|
|
```
|
|
|
|
3. Activate the virtual environment:
|
|
|
|
- On Windows:
|
|
```sh
|
|
.venv\Scripts\activate
|
|
```
|
|
- On macOS/Linux:
|
|
```sh
|
|
source .venv/bin/activate
|
|
```
|
|
|
|
4. Install the required packages:
|
|
```sh
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
### Running the Application
|
|
|
|
1. Start the Flask application:
|
|
```sh
|
|
python main.py
|
|
```
|
|
|
|
2. Open your web browser and navigate to `http://localhost:80`.
|
|
|
|
### Variables
|
|
|
|
The following variables can be found at the top of the `main.py` script:
|
|
|
|
- `html_file_path`: Path to the HTML file to be served.
|
|
- `host`: Host address for the Flask application. Leave at `0.0.0.0` for avability at all network interfaces (localhost / LAN)
|
|
- `port`: Port number for the Flask application.
|
|
- `is_oe11`: Boolean flag for encoding (True for OE11, False for OE12).
|
|
- `scroll_pixels`: Number of pixels to scroll each interval.
|
|
- `scroll_interval`: Time interval (in seconds) between each scroll.
|
|
- `bottom_wait_time`: Time to wait (in seconds) at the bottom of the page before reloading.
|
|
- `top_wait_time`: Time to wait (in seconds) at the top of the page before starting to scroll.
|
|
- `reload_interval`: Time interval (in seconds) to reload the page if no scrolling is needed. Set this value minimum 1 seconds larger than the export interval in OE.
|
|
|
|
### License
|
|
|
|
This project is licensed under the MIT License - see the `LICENSE` file for details. |