Installation

Requirements

• Python 3.9 or higher
• pip package manager
• Network access (for speed tests)

Install from PyPI

The simplest way to install netspecs:

pip install netspecs

Install from Source

For the latest development version:

pip install git+https://github.com/colinconwell/NetSpecs.git

Development Installation

For contributing or local development:

# Clone the repository
git clone https://github.com/colinconwell/NetSpecs.git
cd NetSpecs

# Install with development dependencies
pip install -e ".[dev]"

# Install with documentation dependencies
pip install -e ".[docs]"

# Install everything
pip install -e ".[all]"

Optional Dependencies

Ookla Speedtest CLI

For more accurate speed testing using the same methodology as speedtest.net:

macOSLinux (Debian/Ubuntu)Linux (Fedora/CentOS)Windows

brew install speedtest-cli

curl -s https://install.speedtest.net/app/cli/install.deb.sh | sudo bash
sudo apt-get install speedtest

curl -s https://install.speedtest.net/app/cli/install.rpm.sh | sudo bash
sudo yum install speedtest

Download from speedtest.net/apps/cli and add to PATH.

Note

If Ookla Speedtest CLI is not installed, netspecs will use HTTP-based speed tests instead.

AI Reports

For AI-powered diagnostic reports, you'll need an API key from a supported provider:

• OpenAI: Get a key from platform.openai.com
• Anthropic: Get a key from console.anthropic.com
• Azure OpenAI: Use your Azure deployment credentials

Set your API key as an environment variable:

export OPENAI_API_KEY="your-api-key-here"

Or create a .env.local file in your working directory:

OPENAI_API_KEY=your-api-key-here

Verify Installation

After installation, verify netspecs is working:

netspecs --version

Run a quick connectivity check:

netspecs latency --endpoints 8.8.8.8,1.1.1.1 --count 5