Skip to main content

Environment health checker that validates Python runtime, OS, dependencies, variables and system readiness

Project description

envhealth

Downloads Python Versions License

EnvHealth is a powerful Python utility to check system environment health.

Features

  • Operating System details
  • CPU usage and core stats
  • RAM usage
  • Disk usage
  • CUDA GPU availability + performance benchmark
  • Internet connection diagnostics
  • Proxy configuration detection

Supports multiple report formats:

  • Pretty terminal output
  • JSON
  • HTML
  • PDF

Installation

You can install envhealth via pip:

pip install envhealth

Usage

CLI Usage

  • Run the environment checker in the console:
        envhealth
    
  • Generate HTML, JSON, or Markdown reports:
        envhealth --html
        envhealth --json
        envhealth --pdf
    

Programatic Usage

  • Use envhealth in your Python scripts:
    from envhealth import Checker, Reporter
    
    chk = Checker()
    data = chk.full_report()
    
    rep = Reporter(data)
    print(rep.pretty_text())
    rep.to_pdf()
    

Sample Output

Console Output

    === SYSTEM ===
    os: Windows
    os_version: 10.0.19045
    hostname: PC
    architecture: AMD64
    processor: Intel(R) Core(TM) i5
    python_version: 3.11

    === CPU ===
    physical_cores: 4
    total_cores: 8
    cpu_usage_percent: 12.5

    === MEMORY ===
    total_gb: 16.0
    available_gb: 9.1
    used_percent: 43

    === DISK ===
    total_gb: 512
    used_gb: 320
    free_gb: 192
    used_percent: 62.5

    === CUDA ===
    cuda_available: True
    gpu_name: NVIDIA RTX 3060
    benchmark_time_sec: 0.1182

    === INTERNET ===
    connected: True
    status_code: 200

    === PROXY ===
    proxy_enabled: False

JSON Output

    {
    "system": {
        "os": "Windows",
        "hostname": "PC"
    },
    "cpu": {
        "physical_cores": 4,
        "cpu_usage_percent": 11.3
    },
    "cuda": {
        "cuda_available": true,
        "gpu_name": "RTX 3060"
    },
    "internet": {
        "connected": true
    }
    }

HTML Output

Produces file envhealth_report.html which contains

    <h1>EnvHealth Report</h1>
    <h2>SYSTEM</h2>
    <li><b>os</b>: Windows</li>
    <li><b>hostname</b>: PC</li>
    ...

Support

Supported Platforms:

  • Windows
  • Linux
  • macOS

TODO

  • Roadmap
  • CUDA performance check
  • Internet & proxy diagnostics
  • PDF export
  • GUI dashboard / VS Code integration

License

License: MIT

🤝 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

⭐ Support

If you find this useful, please star the repository.

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

envhealth-0.1.1.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

envhealth-0.1.1-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file envhealth-0.1.1.tar.gz.

File metadata

  • Download URL: envhealth-0.1.1.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for envhealth-0.1.1.tar.gz
Algorithm Hash digest
SHA256 46099eb6595c5e65fe6b7c44794e6349a319dd7fa2274ed55f9127d2a9119fa9
MD5 852add96abeed4fba5c49555347d8df0
BLAKE2b-256 ef5a3c83f3414fae2af73c3c01b1539d16e8e015cef4c96dcfc2538595ab5edb

See more details on using hashes here.

File details

Details for the file envhealth-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: envhealth-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for envhealth-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3718c965309dda102ddcf627794516134c2a3b0b63577b7f0d838a1e1d4d4750
MD5 08b36de103e2db5380e55d8d6deee83c
BLAKE2b-256 ca48071acb4cb57e8e72506866787f2119af03a58e8078a0f2d20d366394a17a

See more details on using hashes here.

Supported by

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