Skip to main content

Cave utilities for the CAVE App at the MIT

Project description

Cave Utilities for the Cave App

Basic utilities for the MIT Cave App. This package is intended to be used by the Cave App and the Cave API.

Setup

Make sure you have Python 3.9.x (or higher) installed on your system. You can download it here.

Installation

pip install cave_utils

Getting Started

Example:

  1. In your cave_app, update the following file:

    cave_api/tests/test_init.py

    from cave_api import execute_command
    from cave_utils.socket import Socket
    from cave_utils.validator import Validator
    
    
    init_session_data = execute_command(session_data={}, socket=Socket(), command="init")
    
    x = Validator(init_session_data)
    
    x.print_errors()
    # x.print_warnings()
    # x.write_warnings('./warnings.txt')
    # x.write_errors('./errors.txt')
    
  2. Run the following command: cave test test_init.py

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

cave_utils-1.5.0b1.tar.gz (15.1 kB view hashes)

Uploaded Source

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