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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cvat_cli-2.19.1.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for cvat_cli-2.19.1.tar.gz
Algorithm Hash digest
SHA256 f70ead4684be26545d38626f7d52136343d31d2fe3ddda2e949217a6c9a6476c
MD5 feb8b01f3d7783fe3ed9f15c188cd3e9
BLAKE2b-256 6231cf7f814f33ea2fcac3abdc6c3ae0a679a7a43c8ee46ef0b14fac4831d044

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cvat_cli-2.19.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2c364d33837f8e9fe4b619b076f1fbfee6e834c5ac02435fba38b1b2254386ce
MD5 48d62f4c375b4784fa67aaad4bb83782
BLAKE2b-256 334ef8ee33645bd1bf38314674f78195d36e2c42604d595f951ece41a7150b9f

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