Skip to content
This repository has been archived by the owner on Sep 16, 2024. It is now read-only.

Latest commit

 

History

History
65 lines (43 loc) · 1.64 KB

README.md

File metadata and controls

65 lines (43 loc) · 1.64 KB
Raw

Installation odm-sdk

Requirements

  • Python 3
  • pip

Instructions

Install

  1. Start a console/terminal:

  2. Install the latest version using pip:

    python3 -m pip install odm-sdk

    To install a specific version of a package, simply append the version number to the package reference in the command. For example: odm-sdk==1.57.0

To check the existing version, and view all available console commands, type

python3 -m pip show --verbose odm-sdk

You can always remove the package with a help of this command

python3 -m pip uninstall odm-sdk

Initial configuration of odm-sdk

  1. Retrieve an Access (Bearer) Token, or obtain an API token by logging into ODM and clicking the profile link under the username.

    See an example for Public user below:

    GetToken

    You need to click on the "Create new token" button, so you will receive an email with a link to your token. Please open the link in the email and save the token for future needs.

  2. Set up your account with the Genestack Python client from a console

    odm-user-setup -H https://domain_name/

  3. Type add to enter a new user, enter an alias for the user.

  4. Enter the host name, which should be of the format: https://domain_name/.

  5. Then select suitable authentication method (1 or 2) and input the content of the token you received in step 1:

    1) by token
2) by access token
3) by email and password
Select authentication: 1
Host: https://domain_name/
Please specify Genestack API token for "my_user":

  6. Type quit to exit the user-setup.