Skip to main content

A diagnostic tool for troubleshooting LUMA Dream Machine API issues

Project description

LUMA API Image Diagnostics

An automated diagnostic suite for troubleshooting image processing issues with the LUMA API. This tool provides a user-friendly wizard interface to run comprehensive tests and generate detailed reports.

Features

  • 🧙‍♂️ Interactive CLI wizard
  • 🔍 Comprehensive image tests
  • 📊 Detailed test reports
  • 📁 Case management
  • 🔑 Secure API key handling
  • 📝 Human-readable outputs
  • 🤖 JSON outputs for automation

Installation

# Clone the repository
git clone https://github.com/caseyfenton/luma-diagnostics.git
cd luma-diagnostics

# Install dependencies
pip install -e .

Quick Start

# Run the diagnostic wizard
luma-diagnostics --wizard

# Or run specific tests
luma-diagnostics --image-url https://example.com/image.jpg --test-type basic

Configuration

  1. Set your LUMA API key:

    # Option 1: Environment variable
    export LUMA_API_KEY=your_api_key
    
    # Option 2: Add to ~/.env file
    echo "LUMA_API_KEY=your_api_key" >> ~/.env
    
    # Option 3: Let the wizard guide you
    luma-diagnostics --wizard
    
  2. Optional: Configure default test parameters in ~/.config/luma-diagnostics/settings.json

Available Tests

Basic Tests

  • URL accessibility
  • Certificate validation
  • Redirect handling
  • MIME type verification
  • Image format validation

Advanced Tests (requires API key)

  • Text-to-Image generation
  • Image-to-Image generation
  • Image-to-Video generation

Case Management

The tool includes a case management system to track issues and test results:

cases/
├── active/          # Active case files
│   └── customer-case-20250122/
│       ├── README.md
│       ├── test_20250122_105752.json
│       └── test_20250122_105752.txt
└── archived/        # Archived cases

Development

Setup Development Environment

# Create virtual environment
python -m venv venv
source venv/bin/activate  # or `venv\Scripts\activate` on Windows

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

Running Tests

pytest

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For issues and feature requests, please use the GitHub issue tracker.

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

luma_diagnostics-0.1.0.tar.gz (36.8 kB view details)

Uploaded Source

Built Distribution

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

luma_diagnostics-0.1.0-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: luma_diagnostics-0.1.0.tar.gz
  • Upload date:
  • Size: 36.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for luma_diagnostics-0.1.0.tar.gz
Algorithm Hash digest
SHA256 22edad1be78e97de4e380f36191d75f90af89c9dc8eacae9f950b6bb72a584b9
MD5 eeb20edd0feb642e38dc88e5d2a15ace
BLAKE2b-256 e659d72a527f6000f1452a5b08b17eae971cc96f96b6f81803a93cd30b82bfd0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for luma_diagnostics-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1e11fab6d2511da0490fdef4ac2a51dff3388514bf68cd0f94e870ab411d1037
MD5 b6ea6346a51ce9ae28e2b0a512fd5b01
BLAKE2b-256 bb855fbd44b4ad30852445e0f3e15a64a2bc64abf2b96f5616464826751fe31a

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