# Labelbox
Core mono-module for Labelbox's Python SDK.
## Table of Contents
- [Setup](#setup)
- [Repository Organization](#repository-organization)
- [Testing](#testing)
## Setup
```bash
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
```bash
rye run unit
```
### Integration Testing
```bash
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](https://labelbox.helpdocs.io/docs/api/getting-started).
**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](https://labelbox.com). 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:
```bash
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](https://pre-commit.com/)
```shell
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:
```bash
rye run lint
```
### Documentation
To generate documentation for all modules (`ReadTheDocs`), run the following command.
```bash
rye run docs
```
Raw data
{
"_id": null,
"home_page": null,
"name": "labelbox",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "ai, edu, labelbox, labeling, llm, machinelearning, ml",
"author": null,
"author_email": "Labelbox <engineering@labelbox.com>",
"download_url": "https://files.pythonhosted.org/packages/22/e3/37bcc27a25a8b966a0095c0c8f33cc32fad3683f332074fbdd6cad3c6c05/labelbox-6.3.0.tar.gz",
"platform": null,
"description": "# Labelbox\n\nCore mono-module for Labelbox's Python SDK.\n\n## Table of Contents\n\n- [Setup](#setup)\n- [Repository Organization](#repository-organization)\n- [Testing](#testing)\n\n## Setup\n\n```bash\nrye sync --all-features # to install labelbox[data] dependencies\n```\n\n## Repository Organization\n\nThe SDK source (excluding tests and support tools) is organized into the\nfollowing packages/modules:\n* `data/` package contains code that maps annotations (labels or pre-labels) to \n Python objects, as well as serialization and deserialization tools for converting \n between NDJson and Annotation Types.\n* `orm/` package contains code that supports the general mapping of Labelbox\n data to Python objects. This includes base classes, attribute (field and\n relationship) classes, generic GraphQL queries etc.\n* `schema/` package contains definitions of classes which represent data type\n (e.g. Project, Label etc.). It relies on `orm/` classes for easy and succinct\n object definitions. It also contains custom functionalities and custom GraphQL\n templates where necessary.\n* `client.py` contains the `Client` class that's the client-side stub for\n communicating with Labelbox servers.\n* `exceptions.py` contains declarations for all Labelbox errors.\n* `pagination.py` contains support for paginated relationship and collection\n fetching.\n* `utils.py` contains utility functions.\n\n## Testing\n\n### Unit Testing\n\n```bash\nrye run unit\n```\n\n### Integration Testing\n\n```bash\nLABELBOX_TEST_API_KEY=\"YOUR_API_TEST_KEY\" LABELBOX_TEST_ENVIRON=\"prod\" rye run integration\n```\nFor more info on how to get a `LABELBOX_TEST_API_KEY` [Labelbox API key docs](https://labelbox.helpdocs.io/docs/api/getting-started). \n\n**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](https://labelbox.com). Free accounts are sufficent for integration testing purposes.**\n\nYou 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`).\n\n### (Optional) Data Testing\n\nFor testing the impact of the extra installs included with `labelbox[data]`, run the following:\n\n```bash\nLABELBOX_TEST_API_KEY=\"YOUR_API_TEST_KEY\" LABELBOX_TEST_ENVIRON=\"prod\" rye run data\n```\n\nBy 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.\n\n### Linting / Formatting\n\nBefore making a commit, to automatically adhere to our formatting standards, it is recommended to install and activate [pre-commit](https://pre-commit.com/)\n```shell\npip install pre-commit\npre-commit install\n```\nAfter the above, running `git commit ...` will attempt to fix formatting,\nand make necessary changes to files. You will then need to stage those files again.\n\nYou may also manually format your code by running the following:\n```bash\nrye run lint\n```\n\n### Documentation\n\nTo generate documentation for all modules (`ReadTheDocs`), run the following command.\n\n```bash\nrye run docs\n```",
"bugtrack_url": null,
"license": null,
"summary": "Labelbox Python API",
"version": "6.3.0",
"project_urls": {
"Changelog": "https://github.com/Labelbox/labelbox-python/blob/develop/libs/labelbox/CHANGELOG.md",
"Documentation": "https://labelbox-python.readthedocs.io/en/latest/",
"Homepage": "https://labelbox.com/",
"Issues": "https://github.com/Labelbox/labelbox-python/issues",
"Repository": "https://github.com/Labelbox/labelbox-python"
},
"split_keywords": [
"ai",
" edu",
" labelbox",
" labeling",
" llm",
" machinelearning",
" ml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a9db94a06053d40db7e3ebb798dc8a3277c5a715e6920031e866703ee4281e76",
"md5": "3881699ec0a6dd68487167a33eac3841",
"sha256": "1987cdf2b380ff8670e0119b5b47013a64fd0ff1e360719e0a89cbd2b86ae7bf"
},
"downloads": -1,
"filename": "labelbox-6.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3881699ec0a6dd68487167a33eac3841",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 227629,
"upload_time": "2024-12-13T01:25:48",
"upload_time_iso_8601": "2024-12-13T01:25:48.532340Z",
"url": "https://files.pythonhosted.org/packages/a9/db/94a06053d40db7e3ebb798dc8a3277c5a715e6920031e866703ee4281e76/labelbox-6.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "22e337bcc27a25a8b966a0095c0c8f33cc32fad3683f332074fbdd6cad3c6c05",
"md5": "4e01069fd28e77834073711d56bd216d",
"sha256": "4dc57508fceba08a317776a24dcfbcd89ba0c6026924f00145c0fbbecaacba79"
},
"downloads": -1,
"filename": "labelbox-6.3.0.tar.gz",
"has_sig": false,
"md5_digest": "4e01069fd28e77834073711d56bd216d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 5055019,
"upload_time": "2024-12-13T01:25:51",
"upload_time_iso_8601": "2024-12-13T01:25:51.739078Z",
"url": "https://files.pythonhosted.org/packages/22/e3/37bcc27a25a8b966a0095c0c8f33cc32fad3683f332074fbdd6cad3c6c05/labelbox-6.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-13 01:25:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Labelbox",
"github_project": "labelbox-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "labelbox"
}
JSON
