Valve

A collection of tools for handling data lake administration. It's primarily a UI to databasin, developed by TPI.

It's currently both a CLI and python wrapper to the databasin REST API.

Installation

pip install git+ssh://[email protected]/i2-wustl/valve.git@main (if private repository)
pip install git+https://github.com/i2-wustl/valve.git@main   (if public respository)

(Currently assuming that you have ssh keys setup to the git provider. Otherwise, use a token based approach.)

Usage

CLI Interface

$ valve --help
Usage: valve [OPTIONS] COMMAND [ARGS]...

  A collection of related tools for handling data lake administration.

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Commands:
  hello  subcommand template

Addtionally, try valve <subcommand> --help for more details on a particular subcommand.

python interface

import valve.core.api as api
debug = True
api.hello(debug)

Documentation

For further information please see the corresponding documentation site (Coming soon!)

Development

Environment Setup

Step 1: Clone and enter the repository

git clone [email protected]:i2-wustl/valve.git valve
cd valve

Step 2: Create and activate a virtual environment

python -m venv venv
source venv/bin/activate

Step 3: Install the code as a "editable" installation

pip install -e .

Step 4: Develop away!

Testing

In the root project directory run:

make test