Skip to main content

Labelbox Python API

Project description

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

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.69.0.tar.gz (5.1 MB view details)

Uploaded Source

Built Distribution

labelbox-3.69.0-py3-none-any.whl (238.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: labelbox-3.69.0.tar.gz
  • Upload date:
  • Size: 5.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for labelbox-3.69.0.tar.gz
Algorithm Hash digest
SHA256 fe326d4eda3791796cb0fd0f50ed0c840190fe3bc39e58fcda3c44f3066754d3
MD5 874be9056300e08a6fe0dd3f2d323d21
BLAKE2b-256 45811849ceb40c709eedd5a22d5621fd626476ba85c06c8fec6f61531cf2bd33

See more details on using hashes here.

File details

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

File metadata

  • Download URL: labelbox-3.69.0-py3-none-any.whl
  • Upload date:
  • Size: 238.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for labelbox-3.69.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dda4a967a452805e7b0a0f09adc5f4912b10e66775e3f20b7f937615d5cb2b0c
MD5 c7356b1f7d608cd2b0d75b75884e1eb1
BLAKE2b-256 0412df1356735ff6a0d7ff1a3d9c3805f6f2e1ca3a925df5175dedace9300d19

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