Skip to main content

Labelbox Python API

Project description

Labelbox Python SDK

Labelbox is the enterprise-grade training data solution with fast AI enabled labeling tools, labeling automation, human workforce, data management, a powerful API for integration & SDK for extensibility. Visit Labelbox for more information.

The Labelbox Python API offers a simple, user-friendly way to interact with the Labelbox back-end.

Table of Contents

Requirements

Installation

Prerequisite: Install pip

pip is a package manager for Python. On macOS, you can set it up to use the default python3 install via -

curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3 get-pip.py

If the installation completes with a warning re: pip not being in your path, you'll need to add it by modifying your shell config (.zshrc, .bashrc or similar). You might have to modify the command below depending on the version of python3 on your machine.

export PATH=/Users/<your-macOS-username>/Library/Python/3.8/bin:$PATH

Install SDK locally, using Python's Pip manager

pip3 install -e .

Install dependencies

pip3 install -r requirements.txt

To install dependencies required for data processing modules use:

pip install labelbox[data]

Documentation

Authentication

Labelbox uses API keys to validate requests. You can create and manage API keys on Labelbox. Pass your API key as an environment variable. Then, import and initialize the API Client.

user@machine:~$ export LABELBOX_API_KEY="<your local api key here>"
user@machine:~$ python3

from labelbox import Client
client = Client()
  • Update api_key and endpoint if not using the production cloud deployment
# On prem
client = Client( endpoint = "<local deployment>")

# Local
client = Client(api_key=os.environ['LABELBOX_TEST_API_KEY_LOCAL'], endpoint="http://localhost:8080/graphql")

# Staging
client = Client(api_key=os.environ['LABELBOX_TEST_API_KEY_LOCAL'], endpoint="https://api.lb-stage.xyz/graphql")

Contribution

Please consult CONTRIB.md

Testing

  1. Update the Makefile with your local, staging, prod API key. Ensure that docker has been installed on your system. Make sure the key is not from a free tier account.
  2. To test on local:
user@machine:~$ export LABELBOX_TEST_API_KEY_LOCAL="<your local api key here>"
make test-local  # with an optional flag: PATH_TO_TEST=tests/integration/...etc LABELBOX_TEST_API_KEY_LOCAL=specify_here_or_export_me
  1. To test on staging:
user@machine:~$ export LABELBOX_TEST_API_KEY_STAGING="<your staging api key here>"
make test-staging # with an optional flag: PATH_TO_TEST=tests/integration/...etc LABELBOX_TEST_API_KEY_STAGING=specify_here_or_export_me
  1. To test on prod:
user@machine:~$ export LABELBOX_TEST_API_KEY_PROD="<your prod api key here>"
make test-prod # with an optional flag: PATH_TO_TEST=tests/integration/...etc LABELBOX_TEST_API_KEY_PROD=specify_here_or_export_me
  1. If you make any changes and need to rebuild the image used for testing, force a rebuild with the -B flag
make -B {build|test-staging|test-prod}
  1. Testing against Delegated Access will be skipped unless the local env contains the key: DA_GCP_LABELBOX_API_KEY. These tests will be included when run against a PR. If you would like to test it manually, please reach out to the Devops team for information on the key.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

labelbox-3.24.0.tar.gz (131.4 kB view details)

Uploaded Source

Built Distribution

labelbox-3.24.0-py3-none-any.whl (170.9 kB view details)

Uploaded Python 3

File details

Details for the file labelbox-3.24.0.tar.gz.

File metadata

  • Download URL: labelbox-3.24.0.tar.gz
  • Upload date:
  • Size: 131.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for labelbox-3.24.0.tar.gz
Algorithm Hash digest
SHA256 53f7a0255fddf4a833b9550b52a33f7990134306fe4db54c7fdd5e484f8e96ca
MD5 95daf544daca65225ae7795287a94d4e
BLAKE2b-256 a7c97d134167615f9f6d2432ad7192438cb3ca16b7c96279f18379b2a5fbc16d

See more details on using hashes here.

File details

Details for the file labelbox-3.24.0-py3-none-any.whl.

File metadata

  • Download URL: labelbox-3.24.0-py3-none-any.whl
  • Upload date:
  • Size: 170.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for labelbox-3.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ead8fe99d6848de106897440c9d67356404c77bfe8fef327cb847d7af95ca637
MD5 73784e020c2a321079673454cb88ac71
BLAKE2b-256 89682c64cd97e84b988f41c5001169eba2cdf537e782e854f681031fc9ee6d82

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page