webperf3 - A web server to display iPerf3 results

Basic setup for development:

1. Install Poetry.

2. Install this project: poetry install.

3. Run the tests: poetry run test/pre_commit_check.py.

Modules

• webperf3.py - A web server to display iPerf3 results
  • Preamble
  • iPerf3 utilities
  • Webserver
  • Websocket and watcher
  • Main
• webperf3.js - Client-side scripts for the webperf3 web app
  • Misc
  • Update the performance table
  • Websocket
• ci_utils.py - Utilities supporting continuous integration tests
  • Imports
  • OS detection
  • Support code
  • Common tools
• ReconnectingWebsocket.js - a Websocket with an automatic reconnect
  • Syntax
  • Parameters
  • Options
• __init__.py - Declare the webperf3 module
• __main__.py - Execute webperf3.py as a module

Development support

A standard dev setup: use Poetry, Black, flake8, mypy, pytest, and coverage.

• pyproject.toml - Project configuration
  • Poetry configuration
  • Black configuration
  • Pytest configuration
• pre_commit_check.py - Run a series of checks that should all pass before submitting a pull request
  • Imports
  • Checks
• test_webperf3.py - Unit tests for ../webperf3/webperf3.py
  • Imports
  • Globals
  • Tests
• mypy configuration
• .flake8 - Flake8 configuration