checkconnectnet

A tiny, dependency-free Python library for checking whether an HTTP or HTTPS endpoint is reachable.

Installation

pip install checkconnectnet

Usage

from checkconnectnet import is_connected

if is_connected():
    print("Online")
else:
    print("Offline")

Without a URL, the library checks its primary endpoint first and automatically uses the public fallback if the first connection fails. You can also choose a custom URL and timeout:

from checkconnectnet import check_connection

result = check_connection("https://example.com", timeout=3)
print(result.connected, result.status_code, result.elapsed_seconds, result.error)

Any HTTP response proves that the network request reached the server, including responses such as 403 or 404.

Flexible GET or POST requests are supported:

from checkconnectnet import is_connected, send_request

online = is_connected(method="GET", params={"source": "desktop"})
result = send_request(
    method="POST",
    params={"source": "server"},
    json={"status": "checking"},
    headers={"X-App": "example"},
)
print(online, result.body)

Get the validated public IPv4 or IPv6 address:

from checkconnectnet import get_public_ip

public_ip = get_public_ip()
print(public_ip)

Command line

checkconnectnet
checkconnectnet --url https://example.com --timeout 3

The command exits with code 0 when connected and 1 when the request fails.

Publishing to PyPI

Create an API token in your PyPI account, then run these commands from this directory:

python -m pip install --upgrade build twine
python -m build
python -m twine check dist/*
$env:TWINE_USERNAME = "__token__"
$env:TWINE_PASSWORD = "pypi-your-api-token"
python -m twine upload dist/*

Do not save the PyPI token in this project or commit it to source control.