COMPutable AScii TUI
Note that we are assuming pip is installed and available
Open a terminal and perform the following to either confirm or install virtualenv:
which virtualenv || pip install --upgrade virtualenv
If you get an error above, you may need to use sudo pip install virtualenv.
With virtualenv installed, you can proceed:
virtualenv -p python3 ~/compas_env
Fine. You don't have to use the above path (or name) for your virtualenv directory, change it if you want, just substitute that name when appropriate.
Activate your environment before repository installation.
source ~/compas_env/bin/activate
Clone the repository into wherever you do such things.
cd <this/is/where>
git clone [email protected]:computablelabs/compas.git
cd compas
pip install -r requirements.txt
Before firing up the ASCII UI Majesty that is Compas, you should do a couple things.
Compas will expect to be able to find public_key and private_key exported in
the running shell session. Note that your private_key is never exposed or broadcast
anywhere as Compas uses Computable.py
to sign transactions locally (offline) and then broadcast the signed transaction via its web3 provider.
So, in a terminal:
export public_key=<0xXxx...>
export private_key=<Xxx...>
Done correctly, echo $public_key and $echo $private_key will show the proper values.
From the root of the repository run the app with:
python compas.py
Note that you should start the App in the same terminal you exported your keys
Their docs on User Interfaces has some handy information until we put together some instructions inside the Compas app itself.