Skip to main content

Command-line client for CVAT

Project description

Command-line client for CVAT

A simple command line interface for working with CVAT tasks. At the moment it implements a basic feature set but may serve as the starting point for a more comprehensive CVAT administration tool in the future.

Overview of functionality:

  • Create a new task (supports name, bug tracker, project, labels JSON, local/share/remote files)
  • Delete tasks (supports deleting a list of task IDs)
  • List all tasks (supports basic CSV or JSON output)
  • Download JPEG frames (supports a list of frame IDs)
  • Dump annotations (supports all formats via format string)
  • Upload annotations for a task in the specified format (e.g. 'YOLO ZIP 1.0')
  • Export and download a whole task
  • Import a task

Installation

pip install cvat-cli

Usage

$ cvat-cli --help

usage: cvat-cli [-h] [--version] [--auth USER:[PASS]]
  [--server-host SERVER_HOST] [--server-port SERVER_PORT] [--debug]
  {create,delete,ls,frames,dump,upload,export,import} ...

Perform common operations related to CVAT tasks.

positional arguments:
  {create,delete,ls,frames,dump,upload,export,import}

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --auth USER:[PASS]    defaults to the current user and supports the PASS
                        environment variable or password prompt
                        (default: current user)
  --server-host SERVER_HOST
                        host (default: localhost)
  --server-port SERVER_PORT
                        port (default: 8080)
  --debug               show debug output

Examples

Create a task with local images:

cvat-cli --auth user create
    --labels '[{"name": "car"}, {"name": "person"}]'
    "test_task"
    "local"
    "image1.jpg" "image2.jpg"

List tasks on a custom server with auth:

cvat-cli --auth admin:password \
    --server-host cvat.my.server.com --server-port 30123 \
    ls

Project details


Download files

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

Source Distribution

cvat-cli-2.6.1.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

cvat_cli-2.6.1-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file cvat-cli-2.6.1.tar.gz.

File metadata

  • Download URL: cvat-cli-2.6.1.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for cvat-cli-2.6.1.tar.gz
Algorithm Hash digest
SHA256 19a7ffe5ec88e2f195429e784d5cc8fd57817224bd76ab5a7294d43c670e6157
MD5 aa46785846740cbd32c7552ad0797b44
BLAKE2b-256 4944c0aa55cc0927934329bcdf189712fe96cd59ae8c19421d895acd8e696e55

See more details on using hashes here.

File details

Details for the file cvat_cli-2.6.1-py3-none-any.whl.

File metadata

  • Download URL: cvat_cli-2.6.1-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for cvat_cli-2.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 09028470011b867746a148232bd4ceb2d3b959a4dad65b21df85ac34a43b42b2
MD5 99277c2590ab0d836891b0e936ff470b
BLAKE2b-256 74b8445ecb5c3089cf8f12554bdee5c3dc8823a35a638298fc11a212d928533b

See more details on using hashes here.

Supported by

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