Skip to main content

Labelbox

Core mono-module for Labelbox's Python SDK.

Table of Contents

Setup

rye sync --all-features # to install labelbox[data] dependencies

Repository Organization

The SDK source (excluding tests and support tools) is organized into the following packages/modules:

  • data/ package contains code that maps annotations (labels or pre-labels) to Python objects, as well as serialization and deserialization tools for converting between NDJson and Annotation Types.
  • orm/ package contains code that supports the general mapping of Labelbox data to Python objects. This includes base classes, attribute (field and relationship) classes, generic GraphQL queries etc.
  • schema/ package contains definitions of classes which represent data type (e.g. Project, Label etc.). It relies on orm/ classes for easy and succinct object definitions. It also contains custom functionalities and custom GraphQL templates where necessary.
  • client.py contains the Client class that's the client-side stub for communicating with Labelbox servers.
  • exceptions.py contains declarations for all Labelbox errors.
  • pagination.py contains support for paginated relationship and collection fetching.
  • utils.py contains utility functions.

Testing

Unit Testing

rye run unit

Integration Testing

LABELBOX_TEST_API_KEY="YOUR_API_TEST_KEY" LABELBOX_TEST_ENVIRON="prod" rye run integration

For more info on how to get a LABELBOX_TEST_API_KEY Labelbox API key docs.

Integration tests by default will run against your account that you provide an API Key from and modify its data. If you want to run integration tests, without it impacting your existing account, create an additional account using a secondary e-mail on Labelbox. Free accounts are sufficent for integration testing purposes.

You can also use a .env file if you prefer instead of needing to type out the environmental overrides every single time you want to run commands. Please add a --env-file parameter to the test command (EG rye --env-file=.env run integration).

(Optional) Data Testing

For testing the impact of the extra installs included with labelbox[data], run the following:

LABELBOX_TEST_API_KEY="YOUR_API_TEST_KEY" LABELBOX_TEST_ENVIRON="prod" rye run data

By default rye sync does not install the extra packages needed in labelbox[data]. You'll need to run rye sync --all-features. Do not checkin requirements.lock or requirements-dev.lock after doing this.

Linting / Formatting

Before making a commit, to automatically adhere to our formatting standards, it is recommended to install and activate pre-commit

pip install pre-commit
pre-commit install

After the above, running git commit ... will attempt to fix formatting, and make necessary changes to files. You will then need to stage those files again.

You may also manually format your code by running the following:

rye run lint

Documentation

To generate documentation for all modules (ReadTheDocs), run the following command.

rye run docs

Metadata

Release files for labelbox 7.16.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for labelbox 7.16.0
File Size Uploaded Provenance
labelbox-7.16.0.tar.gz 5.2 MB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for labelbox 7.16.0
File Interpreter ABI Platform
labelbox-7.16.0-py3-none-any.whl Python 3 none any Details

Total release size: 5.6 MB

Release files / labelbox-7.16.0.tar.gz

Download URL labelbox-7.16.0.tar.gz
Size 5.2 MB
Tags Source
SHA-256 checksum
How to use checksums
45f0dd3993067ea5265cb99762c0dd67e4cf90025d3ecd0c51e8e706c4c27fb3
BLAKE2b-256 checksum
How to use checksums
3487895daeee5d40f832d4a51471ba03def17228f3d4153a3f89902ce1cdb6ff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / labelbox-7.16.0-py3-none-any.whl

Download URL labelbox-7.16.0-py3-none-any.whl
Size 356.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
753ce830d55a3ec3a7b8b7fcc62b2b01a45ed2a8f2d60f0884f802abc01a676a
BLAKE2b-256 checksum
How to use checksums
a88734cb623f405062cb033de69431164c327dafce5ed86d122d3cfcd23419f0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Security for labelbox 7.16.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for labelbox-7.16.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

7.16.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page