Package: labelbox
Labelbox Python SDKLabelbox 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. VisitLabelboxfor more information.The Labelbox Python API offers a simple, user-friendly way to interact with the Labelbox back-end.Table of ContentsLabelbox Python SDKTable of ContentsRequirementsInstallationNote for Windows usersDocumentationAuthenticationContributionTestingRequirementsUse Python 3.7, 3.8, 3.9 and 3.10Create an accountGenerate an API keyInstallationPrerequisite: Install pippipis 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.pyIf 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,.bashrcor 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:$PATHInstall SDK locally, using Python's Pip managerpip3 install -e .Install dependenciespip3 install -r requirements.txtTo install dependencies required for data processing modules use:pip install "labelbox[data]"DocumentationVisit our docsto learn how the SDK worksCheckout ournotebook examplesto follow along with interactive tutorialsview ourAPI reference.AuthenticationLabelbox uses API keys to validate requests. You can create and manage API keys onLabelbox. 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")ContributionPlease consultCONTRIB.mdTestingUpdate theMakefilewith yourlocal,staging,prodAPI key. Ensure that docker has been installed on your system. Make sure the key is not from a free tier account.To test onlocal: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_meTo test onstaging: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_meTo test onprod: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_meIf you make any changes and need to rebuild the image used for testing, force a rebuild with the-Bflagmake -B {build|test-staging|test-prod}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.