Python SDK installation

It is essential to know that any action available on Picsellia's User Interface can also be done programmatically using our Python SDK.

The SDK will allow you to automatize boring tasks to focus only on your work and as a consequence optimize your Computer Vision projects.

How to install and use this Picsellia Python SDK?

1. Prerequisites

Before you get started, you are going to need a few things:

• Your favorite IDE or text editor
• Python 3.7 - Python 3.10
• PIP

2. Set up your virtual environment

Regardless of which package management tool you are using, installing Picsellia in a virtual environment is really recommended. This ensures that the dependencies pulled in for Picsellia don't impact any other Python projects you're working on.

Below are a few tools you can use for environment management:

• pipenv
• poetry
• venv
• virtualenv
• conda

3. Install Picsellia 🥑

To install Picsellia, simply run the following command in your terminal:

pip install picsellia

4. Documentation & first use

All the SDK documentation you need to use it is available here

During the first use of the SDK, we recommend you leverage the recipes tab, which will help you familiarize yourself with the Picsellia package and perform the essential steps.

🚧

If you are in Trial period

In order to initialize a Picsellia client with the Python SDK in the Trial environment, you need to add a "host" argument as shown below:

Python

# Organization name
organization_name = "organization_name"

# Define the environement to connect to
host = "https://trial.picsellia.com"

# Client initialization in the Trial environment
client = Client(api_token="YOUR API TOKEN", organization_name=organization_name, host=host)