Metadata-Version: 2.1
Name: superannotate
Version: 4.4.4.dev1
Summary: Python SDK to SuperAnnotate platform
Home-page: https://github.com/superannotateai/superannotate-python-sdk
Author: SuperAnnotate AI
License: MIT
Project-URL: Documentation, https://superannotate.readthedocs.io/en/stable/
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydicom (>=2.0.0)
Requires-Dist: boto3 (>=1.14.53)
Requires-Dist: requests (==2.26.0)
Requires-Dist: requests-toolbelt (>=0.9.1)
Requires-Dist: tqdm (==4.64.0)
Requires-Dist: pillow (>=7.2.0)
Requires-Dist: matplotlib (>=3.3.1)
Requires-Dist: xmltodict (==0.12.0)
Requires-Dist: opencv-python (>=4.4.0.42)
Requires-Dist: wheel (==0.35.1)
Requires-Dist: packaging (>=20.4)
Requires-Dist: plotly (==4.1.0)
Requires-Dist: ffmpeg-python (>=0.2.0)
Requires-Dist: fire (==0.4.0)
Requires-Dist: mixpanel (==4.8.3)
Requires-Dist: pydantic (>=1.8.2)
Requires-Dist: setuptools (~=57.4.0)
Requires-Dist: aiohttp (==3.8.1)
Requires-Dist: email-validator (>=1.0.3)
Requires-Dist: nest-asyncio (==1.5.4)
Requires-Dist: jsonschema (==3.2.0)
Requires-Dist: pandas (>=1.1.4)
Requires-Dist: aiofiles (==0.8.0)

# SuperAnnotate Python SDK

SuperAnnotate Python SDK allows access to the platform without
 web browser:

```python
import superannotate as sa

sa.create_project("Example Project 1", "example", "Vector")

sa.upload_images_from_folder_to_project("Example Project 1", "<path_to_my_images_folder>")
```

## Installation

SDK is available on PyPI:
 
```console
pip install superannotate
```

The package officially supports Python 3.6+ and was tested under Linux and
Windows ([Anaconda](https://www.anaconda.com/products/individual#windows)) platforms.

For more detailed installation steps and package usage please have a look at the 
[tutorial](https://superannotate.readthedocs.io/en/stable/tutorial.sdk.html).

## Supported Features

- Search projects
- Create/delete a project
- Upload images to a project from a local or AWS S3 folder
- Upload videos to a project from a local folder
- Upload annotations/pre-annotations to a project from local or AWS S3 folder
- Set the annotation status of the images being uploaded
- Export annotations from a project to a local or AWS S3 folder
- Share and unshare a project with a team contributor
- Invite a team contributor
- Search images in a project
- Download a single image
- Copy/move image between projects
- Get image bytes (e.g., for numpy array creation)
- Set image annotation status
- Download image annotations/pre-annotations
- Create/download project annotation classes
- Convert annotation format from/to COCO
- Convert annotation format from VOC, SuperVisely, LabelBox, DataLoop, VGG, VoTT, SageMaker, GoogleCloud, YOLO
- Add annotations to images on platform
- Add annotations to local SuperAnnotate format JSONs
- CLI commands for simple tasks

## Full SDK reference, tutorial available on [Read the Docs](https://superannotate.readthedocs.io)

## License

This SDK is distributed under the MIT License, see [LICENSE](./LICENSE).

## Questions and Issues

For questions and issues please use this repo's issue tracker on GitHub.
