Skip to main content

SDK Setup

Pre-requisites​

To install and ensure maximum compatibility we recommend installing the following

info

We strongly recommend using a Python virtual environment, such as virtual-env or pipenv

Setup​

  • Open a command line to run a GIT command
  • Enter the following: pip install git+https://bitbucket.org/ion-altergo/altergo-sdk.git@release/alpha
  • Once installed you can check that the package is available by running the pip list command

Virtual environment​

info

Make sure you have Installed pipenv to setup the virtual environment

A virtual environment will ensure that you are using the correct version of Python and only the dependencies you need to run the SDK. It will also protect any library you have installed on your system.

Installing SDK​

To create a virtual env and install Altergo-SDK you will need to run this command in your work folder :

pipenv install git+https://bitbucket.org/ion-altergo/altergo-sdk.git@release/alpha#egg=altergo_sdk

Interpreter Make sure the correct interpreter is selected on your IDE, you can press Ctrl + Shift + P on VSCode. Then type in "Interpreter" and select the one present with the path of your work folder

annotely_image.png

In this example the work folder is: example_repository

Verification Once the SDK is installed you can open a new terminal. Make sure that the interpreter is loaded

Wrong interpreter

annotely_image (1).png

Correct interpreter

annotely_image (2).png

The name of the virtual environment is between parentheses

Run pip list and verify that your output is similar to the green highlighted parts: annotely_image (3).png