Index: README.md =================================================================== diff -u -raa29fbbf55f40d940cd4bf50e95792f9b99751bd -r6114b6cad910ab91431069062054e4a549c56400 --- README.md (.../README.md) (revision aa29fbbf55f40d940cd4bf50e95792f9b99751bd) +++ README.md (.../README.md) (revision 6114b6cad910ab91431069062054e4a549c56400) @@ -14,8 +14,47 @@ Please note that the structure of this repository is still under review and the architecture is likely to change as improvements are made. -## Environment Setup +## Using the API + +### Install directly from this repository + +- Your ssh key has already been setup with our internal BitBucket servers +- Your computer must be in the office or you must be on VPN + +How to install from the master branch (Not yet available) +- Will be possible as soon as the dialin_refactoring_3 branch has been merged with the master branch + +``` +#!/bin/bash + +virtualenv --python=python3 venv +source venv/bin/activate +pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git +``` +How to install from the dialin_refactoring_3 branch (Available) + +``` +#!/bin/bash + +virtualenv --python=python3 venv +source venv/bin/activate +branch="dialin_refactoring_3" +pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git@$branch +``` + +### Install from a pre-built .whl file: + +``` +#!/bin/bash + +virtualenv --python=python3 venv +source venv/bin/activate +pip3 install dialin-0.0.1-py3-none-any.whl +``` + +## Dialin API Internal Development Environment + ### Linux After cloning this repository, inside the repository root directory: