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

Uploaded Source

Built Distribution

cvat_cli-2.4.0-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cvat-cli-2.4.0.tar.gz
  • Upload date:
  • Size: 8.8 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.4.0.tar.gz
Algorithm Hash digest
SHA256 54455b70d0364585ff369004f5188f30efb7ed8807c1e3c767c8c26015ab7ba4
MD5 9431107c9a57960176acb4539826d948
BLAKE2b-256 46f54b8efb8be9057c3a1fc6cb79408318343fbb5c39c973f1cb5d7c309cb765

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cvat_cli-2.4.0-py3-none-any.whl
  • Upload date:
  • Size: 8.4 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 63763a170a8d5a554822090b7b69b86ccdecb6c15ffb2f8083f3872194331af4
MD5 86cdc81734a755466306a9cf5918ed4a
BLAKE2b-256 7a0346691fcf76df66538b34f634b7b1720fe957af2f9438fae4a261f2c8ead5

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