https://github.com/chriscarini/speedtest-to-mysql
https://github.com/chriscarini/speedtest-to-mysql
speedtest speedtest-cli speedtest-py speedtest-python
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/chriscarini/speedtest-to-mysql
- Owner: ChrisCarini
- Created: 2023-05-17T01:49:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-17T13:39:46.000Z (over 2 years ago)
- Last Synced: 2024-10-18T07:39:03.558Z (12 months ago)
- Topics: speedtest, speedtest-cli, speedtest-py, speedtest-python
- Language: Python
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `speedtest` to MySQL
This application will perform a network speed test (using the `speedtest` CLI provided by Ookla (speedtest.net)) and
store the results in a MySQL DB.
## Prerequisites
1. `docker-compose`
2. A MySQL DB
## Setup
1. Create a new MySQL DB to use
2. Copy `config.example.yaml` to `config.yaml`
3. Edit the `config.yaml` file with the desired settings.
4. `docker-compose -f docker-compose.yml build`
5. `docker-compose up speedtest_to_mysql -d`
## Maintainer Notes
### Developing Quick Start
The below commands to get the basic setup for developing on this repository.
```shell
python3 -m venv venv
ln -s venv/bin/activate activate
source activate
pip install --upgrade pip
pip install -r requirements.txt
```
### Building the `Dockerfile`
```shell
docker-compose -f docker-compose.yml build
docker-compose -f docker-compose.yml up -d
```
### Publish the Docker image to Docker Hub
```shell
docker login --username chriscarini
VERSION=0.0.1
IMAGE="chriscarini/speedtest-to-mysql"
# Give the image two tags; one version, and one `latest`.
docker build -t "$IMAGE:latest" -t "$IMAGE:$VERSION" .
docker push "$IMAGE:latest" && docker push "$IMAGE:$VERSION"
```
## References
The `speedtest` CLI is as provided by Ookla (speedtest.net).
You can find [installation instructions for your platform here](https://www.speedtest.net/apps/cli).
This project pulls in this CLI into a docker container for easier use.