Add lbox-clients

Author: Val Brodsky

libs/labelbox/src/labelbox/client.py

@@ -4,7 +4,6 @@
 import mimetypes
 import os
 import random
-import sys
 import time
 import urllib.parse
 from collections import defaultdict
@@ -18,6 +17,7 @@
 import labelbox.exceptions
 from labelbox import utils
 from labelbox.adv_client import AdvClient
+from labelbox.client import SDK_VERSION
 from labelbox.orm import query
 from labelbox.orm.db_object import DbObject
 from labelbox.orm.model import Entity, Field
@@ -81,14 +81,6 @@
 
 logger = logging.getLogger(__name__)
 
-_LABELBOX_API_KEY = "LABELBOX_API_KEY"
-
-
-def python_version_info():
-    version_info = sys.version_info
-
-    return f"{version_info.major}.{version_info.minor}.{version_info.micro}-{version_info.releaselevel}"
-
 
 class Client:
     """A Labelbox client.
@@ -126,6 +118,7 @@ def __init__(
         self._data_row_metadata_ontology = None
         self._request_client = RequestClient(
             api_key,
+            sdk_version=SDK_VERSION,
             endpoint=endpoint,
             enable_experimental=enable_experimental,
             app_url=app_url,

libs/lbox-clients/.gitignore

@@ -0,0 +1,10 @@
+# python generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# venv
+.venv

libs/lbox-clients/Dockerfile

@@ -0,0 +1,44 @@
+# https://github.com/ucyo/python-package-template/blob/master/Dockerfile
+FROM python:3.8-slim as rye
+
+ENV LANG="C.UTF-8" \
+    LC_ALL="C.UTF-8" \
+    PATH="/home/python/.local/bin:/home/python/.rye/shims:$PATH" \
+    PIP_NO_CACHE_DIR="false" \
+    RYE_VERSION="0.34.0" \
+    RYE_INSTALL_OPTION="--yes" \
+    LABELBOX_TEST_ENVIRON="prod"
+
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    ca-certificates \
+    curl \
+    inotify-tools \
+    make \
+    # cv2
+    libsm6 \
+    libxext6 \
+    ffmpeg \
+    libfontconfig1 \
+    libxrender1 \
+    libgl1-mesa-glx \
+    libgeos-dev \
+    gcc \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN groupadd --gid 1000 python && \
+    useradd  --uid 1000 --gid python --shell /bin/bash --create-home python
+
+USER 1000
+WORKDIR /home/python/
+
+RUN curl -sSf https://rye.astral.sh/get | bash -
+
+COPY --chown=python:python . /home/python/labelbox-python/
+WORKDIR /home/python/labelbox-python
+
+RUN rye config --set-bool behavior.global-python=true && \
+    rye config --set-bool behavior.use-uv=true && \
+    rye pin 3.8 && \
+    rye sync
+
+CMD rye run unit && rye integration

libs/lbox-clients/README.md

@@ -0,0 +1,9 @@
+# lbox-example
+
+This is an example module which can be cloned and reused to develop modules under the `lbox` namespace.
+
+## Module Status: Experimental
+
+**TLDR: This module may be removed or altered at any given time and there is no offical support.**
+
+Please see [here](https://docs.labelbox.com/docs/product-release-phases) for the formal definition of `Experimental`.

libs/lbox-clients/pyproject.toml

@@ -0,0 +1,62 @@
+[project]
+name = "lbox-example"
+version = "0.1.0"
+description = "This module contains client sdk uses to conntect to the Labelbox API and backends"
+authors = [
+    { name = "Labelbox", email = "engineering@labelbox.com" }
+]
+dependencies = [
+    "requests>=2.22.0",
+    "google-api-core>=1.22.1",
+]
+readme = "README.md"
+requires-python = ">= 3.8"
+
+classifiers=[
+    # How mature is this project?
+    "Development Status :: 2 - Alpha",
+    # Indicate who your project is intended for
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development :: Libraries",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Education",
+    # Pick your license as you wish
+    "License :: OSI Approved :: Apache Software License",
+     # Specify the Python versions you support here.
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+keywords = ["ml", "ai", "labelbox", "labeling", "llm", "machinelearning", "edu"]
+
+[project.urls]
+Homepage = "https://labelbox.com/"
+Documentation = "https://labelbox-python.readthedocs.io/en/latest/"
+Repository = "https://github.com/Labelbox/labelbox-python"
+Issues = "https://github.com/Labelbox/labelbox-python/issues"
+Changelog = "https://github.com/Labelbox/labelbox-python/blob/develop/libs/labelbox/CHANGELOG.md"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.rye]
+managed = true
+dev-dependencies = []
+
+[tool.rye.scripts]
+unit = "pytest tests/unit"
+integration = "python -c \"import sys; sys.exit(0)\""
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/lbox"]
+
+[tool.pytest.ini_options]
+addopts = "-rP -vvv --durations=20 --cov=lbox.example --import-mode=importlib"

libs/lbox-clients/src/lbox/exceptions.py

@@ -1,18 +1,15 @@
-# type: ignore
 import json
 import logging
 import os
 import sys
 from datetime import datetime, timezone
 from types import MappingProxyType
 
+import labelbox.exceptions
 import requests
 import requests.exceptions
 from google.api_core import retry
 
-import labelbox.exceptions
-from labelbox import __version__ as SDK_VERSION
-
 logger = logging.getLogger(__name__)
 
 _LABELBOX_API_KEY = "LABELBOX_API_KEY"
@@ -33,6 +30,7 @@ class RequestClient:
 
     def __init__(
         self,
+        sdk_version,
         api_key=None,
         endpoint="https://api.labelbox.com/graphql",
         enable_experimental=False,
@@ -69,6 +67,7 @@ def __init__(
         self.endpoint = endpoint
         self.rest_endpoint = rest_endpoint
         self._connection: requests.Session = self._init_connection()
+        self.sdk_version = sdk_version
 
     def _init_connection(self) -> requests.Session:
         connection = (
@@ -87,7 +86,7 @@ def _default_headers(self):
             "Authorization": "Bearer %s" % self.api_key,
             "Accept": "application/json",
             "Content-Type": "application/json",
-            "X-User-Agent": f"python-sdk {SDK_VERSION}",
+            "X-User-Agent": f"python-sdk {self.sdk_version}",
             "X-Python-Version": f"{python_version_info()}",
         }
 

libs/labelbox/src/labelbox/request_client.py renamed to libs/lbox-clients/src/lbox/request_client.py

@@ -0,0 +1,10 @@
+
+
+# @patch.dict(os.environ, {'LABELBOX_API_KEY': 'bar'})
+def test_headers():
+    client = RequestClient(api_key="api_key", endpoint="http://localhost:8080/_gql")
+    assert client.headers
+    assert client.headers["Authorization"] == "Bearer api_key"
+    assert client.headers["Content-Type"] == "application/json"
+    assert client.headers["User-Agent"]
+    assert client.headers["X-Python-Version"]