https://github.com/chriscarini/speedtest-to-gsheet
https://github.com/chriscarini/speedtest-to-gsheet
speedtest speedtest-cli speedtest-py speedtest-python
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/chriscarini/speedtest-to-gsheet
- Owner: ChrisCarini
- Created: 2020-09-29T05:48:21.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T19:54:19.000Z (about 2 months ago)
- Last Synced: 2025-04-10T20:48:00.309Z (about 2 months ago)
- Topics: speedtest, speedtest-cli, speedtest-py, speedtest-python
- Language: Python
- Homepage:
- Size: 77.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `speedtest` to gSheet
This application will perform a network speed test (using the `speedtest` CLI provided by Ookla (speedtest.net)) and
store the results in a Google Sheet.
## Prerequisites
1. `docker-compose`
1. A Google account
## Setup
### Create Google Sheet
1. Create a new Google Sheet to use
1. Update `config.yaml` variable `GSHEET_DOC_KEY` with the document key for your new document.
### Create Service Account
1. Head to https://console.developers.google.com/cloud-resource-manager?pli=1
1. Click `Create Project`
1. Name your project `speedtest-to-gsheet` (or whatever you wish)
1. Click `Create`
1. Follow the steps here to enable `Drive + Sheet API` access -> https://gspread.readthedocs.io/en/latest/oauth2.html#enable-api-access
1. Under “APIs & Services > Library”, search for “Drive API” and enable it.
2. Under “APIs & Services > Library”, search for “Sheets API” and enable it.
3. Enable API Access for a Project if you haven’t done it yet.
4. Go to “APIs & Services > Credentials” and choose “Create credentials > Service account key”.
5. Fill out the form
6. Click “Create key”
7. Select “JSON” and click “Create”
8. **Save the file as `speedtest-to-gsheet-service-account-key.json` in the root of this project!!!**
9. Very important! Go to your spreadsheet and share it with a client_email from the step above. Just like you do
with any other Google account. If you don’t do this, you’ll get a gspread.exceptions.SpreadsheetNotFound
exception when trying to access this spreadsheet from your application or a script.
### Configure
1. Edit the `config.yaml` file with the desired settings.
### Build
1. `docker-compose -f docker-compose.yml build`
### Run
1. `docker-compose up speedtest_to_gsheet -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.3
IMAGE="chriscarini/speedtest-to-gsheet"
# 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.