OrCa Hints Library

This repo contains the data for OrCa hints library, as well as a script to "compile" the data to a single JSON file.

Usage

1. Create a virtual env: python3 -m venv ./.venv
2. Activate the virtual env: source ./.venv/bin/activate
3. Install dependencies: pip install -e .
4. "Compile" the hints library: python3 compile.py
5. "Release" a version of the library: ./release.sh <version>. The new version is maintained in file vpesc_library.latest. Note that this process indirectly invokes compile.py
6. "Deploy" the latest version of the library to one of our environments: ./deploy.sh <env>, where env is either dev, internal, staging or local (but see below for how to configure local).

The workflow is to edit hints and metadata inside the library directory, and invoke compile.py to verify things are working. When ready, call release.sh to make a new named release, and then call deploy.sh to upload the latest produced version to one of the SaaS deployments for consumption.

Local deployment to Minio

If you have deployed SaaS locally with Tilt, you have a local Minio object storage service that can host the OrCa hints library. You need to install the rclone tool.