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.12.0.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

cvat_cli-2.12.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file cvat_cli-2.12.0.tar.gz.

File metadata

  • Download URL: cvat_cli-2.12.0.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for cvat_cli-2.12.0.tar.gz
Algorithm Hash digest
SHA256 1c68cae9bfebb5dc104e848132a5887c54598ca8366daa9dc2991d85479f9dca
MD5 b802220d13cba024ca6ba531be128b70
BLAKE2b-256 b010844ee14013d6fde2981c84539d31ca4507f7930089d6b336ea0a5abd113c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cvat_cli-2.12.0-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for cvat_cli-2.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e3816c5339089e1eb90043a8ac54919611e70a075a3cb9d19ed2b738082e496f
MD5 654a79b5b45eb8e7d968cd4146460824
BLAKE2b-256 88f69b04628541246c299da44669028257fb0c1a30c52b7ce4652edb614fc933

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