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='<API key>')
# by config file
# default path is ~/.superannotate/config.ini
sa_client = SAClient(config_path='~/.superannotate/dev_config.ini')config.ini example
[DEFAULT]
SA_TOKEN = <API key>
LOGGING_LEVEL = INFO
LOGGING_PATH = /Users/username/data/superannotate_logsUsing 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.
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.6.0.tar.gz.
File metadata
- Download URL: superannotate-4.6.0.tar.gz
- Upload date:
- Size: 205.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8df6ec4433b2ecc5c143b6cba1aec9ec6920c31ab3a612fc5ddf0a571e4ad43f
|
|
| MD5 |
c3e8f07aa29475e66f89aef4d15743bc
|
|
| BLAKE2b-256 |
7c091e798a64c7a6feeffd2c9a1eca3ff8484a4906e1adda9847f981ea863818
|
File details
Details for the file superannotate-4.6.0-py3-none-any.whl.
File metadata
- Download URL: superannotate-4.6.0-py3-none-any.whl
- Upload date:
- Size: 258.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8357f728bca86e537273912f6c9b50dc54e927efc0522aaeb57d4070c80eef96
|
|
| MD5 |
d832169e55b26747c35b2a90646a7629
|
|
| BLAKE2b-256 |
d90d83e5c363fe28a0f54a372c022731a494f4c04c6191b293a7179d7635de73
|
