Skip to main content
The vital PyPI package (Junction API Python SDK) provides typed bindings of the Junction API in Python that tracks our OpenAPI Schema.Junction Sense Python SDK is a standalone product offering, separately from the vital PyPI package.
Junction Sense Python SDK bridges Junction’s data aggregation and intelligence capabilities with the rich Python ecosystem for scientific computing and data analysis.

​
Authentication

Deployed Services

Use the same Vital API Keys your system used to interact with Junction API.To set the Junction API Key for the Junction Sense Python SDK, you can:
  • Pass the Junction API Key explicitly to the Junction Sense SDK entity’s constructor (e.g., the Query Executor); or
  • Set the Junction API Key as the VITAL_API_KEY environment variable.

Data Scientists and Developers

Sign-in locally on your machine with your Junction Dashboard account. You can do so through the Junction Sense SDK Command Line Tool as detailed below.

​
Installation

​
Aggregation API

1

Add a dependency

Add the vitalx-aggregation package to your project.
poetry add vitalx-aggregation

​
SDK Command Line Tool

1

Add a dependency

Add the vitalx-cli package as a dev dependency to your project.
poetry add -G dev vitalx-cli
2

Start the device authentication process

Create the ~/.vitalx directory, and grant it execute permission. The SDK requires execute permission to maintain a file lock.
mkdir -p ~/.vitalx && chmod +x ~/.vitalx
Call the auth login CLI subcommand on the vitalx-cli package to start the authentication process.
poetry run vitalx-cli auth login
3

Sign in with your Junction Dashboard account

You would be prompted in your default web browser to sign-in to the Junction Dashboard. You will then be asked to confirm the device authorization.
Device Confirmation prompt
4

Voila!

You have now signed-in. You can now use any Junction Sense SDK entity without a Junction API Key.
Your permanent session is stored at ~/.vitalx/.

​
Example

tryvital/vitalx-notebook is a pre-configured Jupyter Notebook project with dependencies on Aggregation API and SDK Command Line Tool pre-configured. The notebook also includes an example to compute Chronotypes using the Aggregation API.