Installation

Build from Source Code

Prerequisites

  • Python 3

  1. Git clone project

git clone https://github.com/msk-mind/cli.git

  1. Set up environment for CLI

# create a virtual environment
python -m venv env # or python3
source env/bin/activate

# install required libraries in the env
pip install -r requirements.txt

  1. (Optional) Generate executable

pyinstaller --onefile mind.py

The executable will be at dist/mind.

  1. Test executable.

$ ./dist/mind

Usage: mind [OPTIONS] COMMAND [ARGS]...

  Welcome to MSK MIND!

Options:
  --host TEXT  [default: http://localhost:8080]
  --help       Show this message and exit.

Commands:
  download        download data.
  list-columns    show available columns given database and table.
  list-databases  show available databases.
  list-tables     show available tables given a database.
  query           query data.

Note: If you see an ASCII error while running the executable, set your locale by running:

export LANG=en_US.utf-8

For details, please see click documentation here: https://click.palletsprojects.com/python3/

Download

TODO - provide macOS, linux executables in bin/ upon release.