Alvin CLI.
Project description
Alvin CLI
Alvin CLI Library.
Table of Contents
1. Installation
Install this library in a virtualenv using pip. virtualenv is a tool to create isolated Python environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions.
With virtualenv, it's possible to install this library without needing system install permissions, and without clashing with the installed system dependencies. Make sure you use Python 3.7+.
1.1. Mac/Linux
pip3 install virtualenv
virtualenv --python python3.7 <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install alvin-cli
1.2. Windows
pip3 install virtualenv
virtualenv --python python3.7 <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install alvin-cli
2. Environment setup
2.1 Available parameters
Set the Required parameters in the alvin.cfg
file.
Run alvin setup
. This will create alvin.cfg
in your root directory under alvin
.
Set up your credentials there. Generate a new API Token from https://app.alvin.ai/admin/api-keys and paste that in the configuration file along with your alvin_platform_id
.
Below is the representation of required and optional parameters for setup
Name | Description | Required | Default Value | Sample Value |
---|---|---|---|---|
ALVIN_API_TOKEN | Generated from the Alvin website | Y | N/A | HhiE6LbAAOZf-Xn9Pa4MdiC-KgR4W1OuWYsGWeO8OO0= |
ALVIN_PLATFORM_ID | Platform ID used to create the connection on Alvin | Y | N/A | alv |
ALVIN_UI_HOST | Used to build the Alvin UI URL, according to ENV | N | https://app.alvin.ai | https://app.alvin.ai |
ALVIN_API_HOST | Used to build the Alvin UI URL, according to ENV | N | https://app.alvin.ai | https://app.alvin.ai |
DEBUG | Flag to enable verbose debug logging | N | true | true |
3. Execution
Example commands to run after setting up the configuration file
- alvin available commands
alvin --help
- current user info
alvin current-user
- list of platforms
alvin platform list
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for alvin_cli-0.0.1a0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b215debf38160fffa665d1a274e8cb4c0bb3bed80effb7f4e6f2fcbf76cfab68 |
|
MD5 | a7e185533bed5033204a0c9cfd81fea8 |
|
BLAKE2b-256 | c20943b6be17217e39f133faf457281515cc10a66b4e75a520a1cb04bfb02706 |