Skip to main content

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

Project description

envhealth

Downloads Python Versions License

Environment Health Checker for Python Projects


Features

  • Detects Python version issues
  • Detects dependency conflicts
  • Checks RAM, CPU, OS info
  • Detects GPU availability
  • Generates:
    • Console Report
    • HTML Report
    • JSON Report
    • Markdown Report
  • Colored terminal output
  • Zero configuration

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 --markdown
    
  • Combine multiple formats:
        envhealth --html --json --markdown
    

Programatic Usage

  • Use envhealth in your Python scripts:
    from envhealth import EnvironmentChecker, ConsoleReporter, HTMLReporter, JSONReporter, MarkdownReporter
    
    # Run all checks
    checker = EnvironmentChecker()
    results = checker.run_all()
    
    # Console output
    ConsoleReporter().render(results)
    
    # Save reports
    HTMLReporter().save(results, path="env_report.html")
    JSONReporter().save(results, path="env_report.json")
    MarkdownReporter().save(results, path="env_report.md")
    

Sample Output

Console Output

    === PYTHON ENVIRONMENT HEALTH REPORT ===
    Generated: 2025-01-01 18:22:11
    ----------------------------------------

    Python:
    current_version: 3.11.7
    minimum_required: 3.8
    status: OK

    System:
    os: Linux
    os_release: 6.6.10
    cpu_count: 12
    ram_gb: 16.0

    GPU:
    Available: False

    Dependency Conflicts:
    None

    Warnings:
    None

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.0.tar.gz (5.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.0-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: envhealth-0.1.0.tar.gz
  • Upload date:
  • Size: 5.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.0.tar.gz
Algorithm Hash digest
SHA256 080f596ef5514714d6cddd44871d5ca3b42a7512938b74eb709f3bb37e2a87e1
MD5 7cdf5f91e1c9a84917a8c695f0455cb6
BLAKE2b-256 4c68f715a06ff31e8be23211a94353e590d9228d67de7d136d2cc76ecc8ce4aa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: envhealth-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.0 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0910d543bdd032a303a117e157a86493173c1765ad2fd9e83b4dc1fd94a7fbe8
MD5 b6d83ff4496660ffb7f8da94c9004fd1
BLAKE2b-256 0fe7f8a0722ea0cd320a835b96957adb877138d731ce6cb8ae2c0423a5e96b25

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