Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

SuperAnnotate Python SDK

Python Versions License Changelog

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

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_logs

Using 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 superannotate

The 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.

Metadata

Release files for superannotate 4.6.3b1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for superannotate 4.6.3b1
File Size Uploaded Provenance Actions
superannotate-4.6.3b1.tar.gz 225.0 kB Without provenance Details for superannotate-4.6.3b1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for superannotate 4.6.3b1
File Interpreter ABI Platform Actions
superannotate-4.6.3b1-py3-none-any.whl Python 3 none any Details for superannotate-4.6.3b1-py3-none-any.whl

Total release size: 504.7 kB

Release files / superannotate-4.6.3b1.tar.gz

Download URL superannotate-4.6.3b1.tar.gz
Size 225.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b673efb8e7489704b017ea9100d0d0d43acf1683c161b9cd12dd8b041b6ad65d
BLAKE2b-256 checksum
How to use checksums
f20cdf9bc8b4b24cfd2b3a41978183a0d030384e59a5d29de9385c8e71353135
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / superannotate-4.6.3b1-py3-none-any.whl

Download URL superannotate-4.6.3b1-py3-none-any.whl
Size 279.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7aeb69921166bd000d674d75c5adae69461212a59db598ce2ea5968d6863bad7
BLAKE2b-256 checksum
How to use checksums
3f5635cad1da9fe0d4eb36f38b3869b0f7f2539c62dfe556eb45117afd43be89
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for superannotate 4.6.3b1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page