Skip to main content

Python SDK Installation

Requirements​

Make sure you are running:

  • Python 3.9 or above
  • One of the following OS:
    • macOS (≥ 10.9)
    • Windows (any version supporting 64bit)
    • Linux (any version supporting 64bit)

Decentriq suggests using the SDK from a clean Python environment.

Instructions​

Follow the instruction below to proceed with the environment creation and the installation:

  1. Open a terminal window.

  2. Create a new directory and navigate into it.

  3. Create a new virtual environment to install into. You can use, for instance, Python's own venv package:

    python -m venv env
    source env/bin/activate

  4. Make sure that you have the latest version of pip installed:

    pip install --upgrade pip

  5. Install the decentriq_platform package:

    pip install decentriq_platform

  6. Test that the installation was successful. The following shouldn't print an error:

    python -c "import decentriq_platform"

Importing​

In your Python script or Jupyter notebook, import the Decentriq library:

import decentriq_platform as dq

Next steps​

Now that you have installed the SDK, read the "getting started" tutorial that most suits your use case: