# SDK for [Computer Vision Annotation Tool (CVAT)](https://github.com/cvat-ai/cvat)
This package provides a Python client library for CVAT server. It can be useful for
workflow automation and writing custom CVAT server clients.
The SDK API includes several layers:
- Server API wrappers (`ApiClient`). Located in at `cvat_sdk.api_client`.
- High-level tools (`Core`). Located at `cvat_sdk.core`.
- PyTorch adapter. Located at `cvat_sdk.pytorch`.
* Auto-annotation support. Located at `cvat_sdk.auto_annotation`.
Package documentation is available [here](https://docs.cvat.ai/docs/api_sdk/sdk).
## Installation & Usage
To install a prebuilt package, run the following command in the terminal:
```bash
pip install cvat-sdk
```
To use the `cvat_sdk.masks` module, request the `masks` extra:
```bash
pip install "cvat-sdk[masks]"
```
To use the PyTorch adapter or the built-in PyTorch-based auto-annotation functions,
request the `pytorch` extra:
```bash
pip install "cvat-sdk[pytorch]"
```
To install from the local directory, follow [the developer guide](https://docs.cvat.ai/docs/api_sdk/sdk/developer_guide).
After installation you can import the package:
```python
import cvat_sdk
```
Raw data
{
"_id": null,
"home_page": "https://github.com/cvat-ai/cvat",
"name": "cvat-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, CVAT REST API",
"author": "CVAT.ai team",
"author_email": "support@cvat.ai",
"download_url": "https://files.pythonhosted.org/packages/03/c2/64f06677f7df19d3ec7ea766168516a0891d4e1253c47f9f97c946cc39ae/cvat_sdk-2.25.0.tar.gz",
"platform": null,
"description": "# SDK for [Computer Vision Annotation Tool (CVAT)](https://github.com/cvat-ai/cvat)\n\nThis package provides a Python client library for CVAT server. It can be useful for\nworkflow automation and writing custom CVAT server clients.\n\nThe SDK API includes several layers:\n\n- Server API wrappers (`ApiClient`). Located in at `cvat_sdk.api_client`.\n- High-level tools (`Core`). Located at `cvat_sdk.core`.\n- PyTorch adapter. Located at `cvat_sdk.pytorch`.\n* Auto-annotation support. Located at `cvat_sdk.auto_annotation`.\n\nPackage documentation is available [here](https://docs.cvat.ai/docs/api_sdk/sdk).\n\n## Installation & Usage\n\nTo install a prebuilt package, run the following command in the terminal:\n\n```bash\npip install cvat-sdk\n```\n\nTo use the `cvat_sdk.masks` module, request the `masks` extra:\n\n```bash\npip install \"cvat-sdk[masks]\"\n```\n\nTo use the PyTorch adapter or the built-in PyTorch-based auto-annotation functions,\nrequest the `pytorch` extra:\n\n```bash\npip install \"cvat-sdk[pytorch]\"\n```\n\nTo install from the local directory, follow [the developer guide](https://docs.cvat.ai/docs/api_sdk/sdk/developer_guide).\n\nAfter installation you can import the package:\n\n```python\nimport cvat_sdk\n```\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "CVAT REST API",
"version": "2.25.0",
"project_urls": {
"Homepage": "https://github.com/cvat-ai/cvat"
},
"split_keywords": [
"openapi",
" openapi-generator",
" cvat rest api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "984a6cd0c21a5d2f8908f969445981c70a53fea5e6f826efbf021ca50df2300a",
"md5": "70a339d593027a7bb4f1996a94f1a28a",
"sha256": "dc52b8ba1b9358902462846e004580b7b9baeed76b742b5f49a11c141a800eb7"
},
"downloads": -1,
"filename": "cvat_sdk-2.25.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70a339d593027a7bb4f1996a94f1a28a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 791050,
"upload_time": "2025-01-09T18:18:19",
"upload_time_iso_8601": "2025-01-09T18:18:19.653705Z",
"url": "https://files.pythonhosted.org/packages/98/4a/6cd0c21a5d2f8908f969445981c70a53fea5e6f826efbf021ca50df2300a/cvat_sdk-2.25.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "03c264f06677f7df19d3ec7ea766168516a0891d4e1253c47f9f97c946cc39ae",
"md5": "10a32992fedca5dde2a0056caaf59b59",
"sha256": "65c7faf74fbbd4ca799efa31774d6c378afed55d0a4c6e1141a6621845f35178"
},
"downloads": -1,
"filename": "cvat_sdk-2.25.0.tar.gz",
"has_sig": false,
"md5_digest": "10a32992fedca5dde2a0056caaf59b59",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 237991,
"upload_time": "2025-01-09T18:18:25",
"upload_time_iso_8601": "2025-01-09T18:18:25.044060Z",
"url": "https://files.pythonhosted.org/packages/03/c2/64f06677f7df19d3ec7ea766168516a0891d4e1253c47f9f97c946cc39ae/cvat_sdk-2.25.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-09 18:18:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cvat-ai",
"github_project": "cvat",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "cvat-sdk"
}
JSON
