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

Download files

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

Source Distribution

labelbox-7.12.0.tar.gz (5.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

labelbox-7.12.0-py3-none-any.whl (330.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: labelbox-7.12.0.tar.gz
  • Upload date:
  • Size: 5.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for labelbox-7.12.0.tar.gz
Algorithm Hash digest
SHA256 d3d04f750edcbc3674a4b43507b45ae36c66bf55c4375be21f50f45f086b6d0f
MD5 9b9a17ffd0f5196aba3737dd70515587
BLAKE2b-256 94d8f89c5c5c5f3c87c827043e53f7a229cf47d893507e90fa384646c4bff8d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for labelbox-7.12.0.tar.gz:

Publisher: publish.yml on Labelbox/labelbox-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: labelbox-7.12.0-py3-none-any.whl
  • Upload date:
  • Size: 330.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for labelbox-7.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e3feb221ddddf53a4731c0b80f3c06c7f685aa3ba79e9bc98c620cb62c6c0976
MD5 23e2dd8fc5f7ff6ee51128cfd85ec200
BLAKE2b-256 2a54173a0cf56742cafaac55284490d38e1c4ac3939b6778797455bfc5757825

See more details on using hashes here.

Provenance

The following attestation bundles were made for labelbox-7.12.0-py3-none-any.whl:

Publisher: publish.yml on Labelbox/labelbox-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

7.12.0 This release

2 files

7.11.0

2 files

7.10.0

2 files

7.9.0

2 files

7.8.0

2 files

7.7.0

2 files

7.6.0

2 files

7.5.0

2 files

7.4.0

2 files

7.3.0

2 files

7.2.0

2 files

7.1.2

2 files

7.1.1

2 files

7.1.0

2 files

7.0.0

2 files

6.10.0

2 files

6.9.0

2 files

6.8.0

2 files

6.7.0

2 files

6.6.0

2 files

6.5.0

2 files

6.4.0

2 files

6.3.0

2 files

6.2.0

2 files

6.1.0

2 files

6.0.1

2 files

6.0.0

2 files

5.2.1

2 files

5.2.0

2 files

5.1.0

2 files

5.0.0

2 files

4.0.0

2 files

3.78.2

2 files

3.78.1

2 files

3.78.0

2 files

3.77.1

2 files

3.77.0

2 files

3.76.0

2 files

3.75.1

2 files

3.75.0

2 files

3.74.0

2 files

3.73.0

2 files

3.72.2

2 files

3.72.1

2 files

3.72.0

2 files

3.71.0

2 files

3.70.0

2 files

3.69.1

2 files

3.69.0

2 files

3.68.0

2 files

3.67.0

2 files

3.66.0

2 files

3.65.0

2 files

3.63.0

2 files

3.62.0

2 files

3.61.2

2 files

3.61.1

2 files

3.61.0

2 files

3.60.0

2 files

3.59.0

2 files

3.58.1

2 files

3.58.0

2 files

3.57.0

2 files

3.56.0

2 files

3.55.0

2 files

3.54.1

2 files

3.54.0

2 files

3.53.0

2 files

3.52.0

2 files

3.51.0

2 files

3.50.0

2 files

3.49.1

2 files

3.49.0

2 files

3.48.0

2 files

3.47.1

2 files

3.47.0

2 files

3.46.0

2 files

3.45.0

2 files

3.44.0

2 files

3.43.0

2 files

3.42.0

2 files

3.41.0

2 files

3.40.1

2 files

3.40.0

2 files

3.39.0

2 files

3.38.0

2 files

3.37.0

2 files

3.36.1

2 files

3.36.0

2 files

3.35.0

2 files

3.34.0

2 files

3.33.1

2 files

3.33.0

2 files

3.32.0

2 files

3.31.0

2 files

3.30.1

2 files

3.30.0

2 files

3.29.0

2 files

3.28.0

2 files

3.27.2

2 files

3.27.1

2 files

3.27.0

2 files

3.26.2

2 files

3.26.1

2 files

3.26.0

2 files

3.25.3

2 files

3.25.2

2 files

3.25.1

2 files

3.25.0

2 files

3.24.1

2 files

3.24.0

2 files

3.23.3

2 files

3.23.2

2 files

3.23.1

2 files

3.22.1

2 files

3.22.0

2 files

3.21.0

2 files

3.20.1

2 files

3.20.0

2 files

3.19.1

2 files

3.19.0

2 files

3.18.0

2 files

3.17.2

2 files

3.17.1

2 files

3.17.0

2 files

3.16.0

2 files

3.15.0

2 files

3.14.0

2 files

3.13.1

2 files

3.13.0

2 files

3.12.0

2 files

3.11.1

2 files

3.11.0

2 files

3.10.0

2 files

3.9.0

2 files

3.8.0

2 files

3.7.0

2 files

3.6.1

2 files

3.6.0

2 files

3.5.0

2 files

3.4.1

2 files

3.4.0

2 files

3.3.0

2 files

3.2.1

2 files

3.2.0

2 files

3.1.0

2 files

3.0.1

2 files

3.0.0

2 files

2.7.0

3 files

2.6.0

3 files

2.5.6

3 files

2.5.5

3 files

2.5.4

3 files

2.5.3

3 files

2.5.2

3 files

2.5.1

3 files

2.4.11

3 files

2.4.10

3 files

2.4.9

3 files

2.4.8

2 files

2.4.6

2 files

2.4.5

2 files

2.4.4

2 files

2.4.3

2 files

2.4.2

2 files

2.4.1

3 files

2.4

4 files

2.3

2 files

2.2

2 files

2.1

2 files

2.0.1

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

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