Skip to main content

A simple python application for running checks against websites.

Project description

Tests Release PyPI pre-commit

website_checker

A simple python application for running checks against websites.

Usage

Install

$ pipx install website-checker
  installed package site-check 0.1.0, Python 3.9.0
  These apps are now globally available
    - check
done!  🌟 # or install into system python with pip
# pip install website-checker

Example

Display help message

$ check --help
Usage: check [OPTIONS] COMMAND [ARGS]...

  A simple python application for running checks against websites.

Options:
  --debug / --no-debug  Toggle debug mode.
  --version             Show the version and exit.
  --help                Show this message and exit.

Commands:
  health   Check website health.
  latency  Check website latency.
  network  Check website network connectivity.

Some examples

$ check network -u https://google.com -u https://blarg.com
{"event": {"check": "network", "input": {"timeout": 5, "url": "https://google.com"}, "output": "pass"}, "logger": "website-checker", "timestamp": "2020-11-30T05:27:23.413281"}
{"event": {"check": "network", "input": {"timeout": 5, "url": "https://blarg.com"}, "output": "fail"}, "logger": "website-checker", "timestamp": "2020-11-30T05:27:23.443994"}

$ check health -u https://google.com
{"event": {"check": "health", "input": {"timeout": 5, "url": "https://google.com"}, "output": "pass"}, "logger": "website-checker", "timestamp": "2020-11-30T05:27:49.413241"}

$ check latency -u https://google.com
{"event": {"check": "latency", "input": {"threshold": 500, "timeout": 5, "url": "https://google.com"}, "output": "pass"}, "logger": "website-checker", "timestamp": "2020-11-30T05:28:14.460530"}

Docker

$ docker run --rm -it aidanmelen/website-checker health --url https://google.com
{"event": {"check": "health", "input": {"timeout": 5, "url": "https://google.com"}, "output": "pass"}, "logger": "website-checker", "timestamp": "2020-11-30T05:00:23.444290"}

License

Check out the LICENSE for more information.

Credits

Check out the CREDITS for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

website-checker-0.3.3.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

website_checker-0.3.3-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file website-checker-0.3.3.tar.gz.

File metadata

  • Download URL: website-checker-0.3.3.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.0 Linux/5.4.0-1031-azure

File hashes

Hashes for website-checker-0.3.3.tar.gz
Algorithm Hash digest
SHA256 a35b030d19638d4066d0164321b1ce30bc1d3072a5f6d5066e606e79b56d54ca
MD5 de048b52ba60247c621492a558d07132
BLAKE2b-256 3c82c42fa5b9b1f19d5480cc9ea45e6f199b00143e2aeabdeb6cbd76da1b958e

See more details on using hashes here.

File details

Details for the file website_checker-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: website_checker-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.0 Linux/5.4.0-1031-azure

File hashes

Hashes for website_checker-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 535429d337b59aff2c9316c6bd86175a6ea868793e154960dc6a7c7c2344d013
MD5 0215feabbbcbd7362a2b43102e9f8a9c
BLAKE2b-256 c459f957eb2d623237613d880d846c7c9d50ec34059876039a5ea523a93aeba9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page