Welcome to the SuperAnnotate Python Software Development Kit (SDK), which enables Python programmers to create software that incorporates services of the platform and effortlessly integrates SuperAnnotate into their AI process.
Resources
API Reference and User Guide available on Read the Docs
Authentication
from superannotate import SAClient
# by environment variable SA_TOKEN
sa_client = SAClient()
# by token
sa_client = SAClient(token='<team token>')
# by config file
# default path is ~/.superannotate/config.ini
sa_client = SAClient(config_path='~/.superannotate/dev_config.ini')config.ini example
[DEFAULT]
SA_TOKEN = <Token>
LOGGING_LEVEL = INFOUsing superannotate
from superannotate import SAClient
sa_client =SAClient()
project = 'Dogs'
sa_client.create_project(
project_name=project,
project_description='Test project generated via SDK',
project_type='Vector'
)
sa_client.create_annotation_class(
project=project,
name='dog',
color='#F9E0FA',
class_type='tag'
)
sa_client.attach_items(
project=project,
attachments=[
{
'url': 'https://drive.google.com/uc?export=download&id=1ipOrZNSTlPUkI_hnrW9aUD5yULqqq5Vl',
'name': 'dog.jpeg'
}
]
)
sa_client.upload_annotations(
project=project,
annotations=[
{
'metadata': {'name': 'dog.jpeg'},
'instances': [
{'type': 'tag', 'className': 'dog'}
]
}
]
)
sa_client.get_annotations(project=project, items=['dog.jpeg'])Installation
SuperAnnotate python SDK is available on PyPI:
pip install superannotateThe package officially supports Python 3.10+ and was tested under Linux and Windows (Anaconda ) platforms.
Supported Features
search/get/create/clone/update/delete projects
search/get/create/delete folders
assign folders to project contributors
upload items to a project from a local or AWS S3 folder
attach items by URL or from an integrated storage, meanwhile keeping them secure in your cloud provider
get integrated cloud storages
upload annotations (also from local or AWS S3 folder)
delete annotations
set items annotations statuses
get/download/export annotations from a project (also to a local or AWS S3 folder)
invite/search team contributors or add contributors to a specific project
search/get/copy/move items in a project
query items using SA Query Language
define custom metadata for items and upload custom values (query based on your custom metadata)
upload priority scores
get available subsets (sets of segregated items), query items in a subset or add items to a subset
assign or anassign items to project contributors
download an image that has been uploaded to project
search/create/download/delete project annotation classes
search/download models
run predictions
convert annotations from/to COCO format
convert annotation from VOC, SuperVisely, LabelBox, DataLoop, VGG, VoTT, SageMaker, GoogleCloud, YOLO formats
CLI commands for simple tasks
Questions and Issues
For questions and issues please use this repo’s issue tracker on GitHub or contact support@superannotate.com.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file superannotate-4.5.6.tar.gz.
File metadata
- Download URL: superannotate-4.5.6.tar.gz
- Upload date:
- Size: 197.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
226c1eedbcf980b33d4310564bdeb428ebebbf2aa4bb0d9ae280f16dfdb1b4b9
|
|
| MD5 |
aa722bbf1eda62d0b59aa58746fc62f5
|
|
| BLAKE2b-256 |
5dcf50fe4702ef3db60a9d05f804c6526fcba57efe548afd88a53561c272ebb2
|
File details
Details for the file superannotate-4.5.6-py3-none-any.whl.
File metadata
- Download URL: superannotate-4.5.6-py3-none-any.whl
- Upload date:
- Size: 248.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f83ff3452a3d88f036751dfbb99a9ed9a433c4468ff8eae99946f7ff756537cc
|
|
| MD5 |
5745f9120e86b2a5582e534bb88dde18
|
|
| BLAKE2b-256 |
ce84b1ea980ffff256cf15663aa45edc6f422fc6d92efc9b64196097617e7382
|
