Skip to main content

Python SDK to SuperAnnotate platform

Project description

SuperAnnotate Python SDK

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

import superannotate as sa

sa.init("<path_to_my_config_json>")

projects = sa.search_projects("Example Project 1")

example_project = projects[0]
sa.upload_images_from_folder_to_project(example_project, "<path_to_my_images_folder>")

Installation

SDK is available on PyPI:

pip install superannotate

for COCO annotation format converters support also need to install:

pip install 'git+https://github.com/cocodataset/panopticapi.git'
pip install 'git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI'

The package officially supports Python 3.6+.

For further steps please have a look at the tutorial.

Supported Features

  • Search projects
  • Create/delete a project
  • Upload images to a project from local or AWS S3 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
  • Add annotations to images on platform
  • Add annotations to local SuperAnnotate format JSONs

Full SDK reference, tutorial available on Read the Docs

License

This SDK is distributed under the MIT License, see LICENSE

Questions and Issues

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

superannotate-1.5.9.tar.gz (148.2 kB view details)

Uploaded Source

File details

Details for the file superannotate-1.5.9.tar.gz.

File metadata

  • Download URL: superannotate-1.5.9.tar.gz
  • Upload date:
  • Size: 148.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.7.8

File hashes

Hashes for superannotate-1.5.9.tar.gz
Algorithm Hash digest
SHA256 38a781dd5588ebc76c6c98f9ab1d32b0086cfe5874f940e58863e9291f49c5ee
MD5 fec43cb1f600ef527873cf2cfa5592cf
BLAKE2b-256 fe98c4e3e5550e15f795b7e14cf34007b02b9a448fefdc24df93f7ec13645314

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page