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.1.0.post1.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

cvat_cli-2.1.0.post1-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file cvat-cli-2.1.0.post1.tar.gz.

File metadata

  • Download URL: cvat-cli-2.1.0.post1.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for cvat-cli-2.1.0.post1.tar.gz
Algorithm Hash digest
SHA256 08749d838ebed5385b4afdbcb0ce6ba815263cb5579b0af5d18a5bca5bfb5573
MD5 9ef477d335ba6feb3aa20d7a144bf712
BLAKE2b-256 1e665d77cb579570715a4dcb2fbc4b574f416d098480c991d99c89afb1cd1038

See more details on using hashes here.

File details

Details for the file cvat_cli-2.1.0.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for cvat_cli-2.1.0.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 c83d66b3373298a61468058a70959f9a0f6893ce71a24a83ae242f8f778da57e
MD5 3bbd089f955f567764f72778682d3ea4
BLAKE2b-256 6802277b73f55235dc73b3a75df03d5fa79d9f3707266143349d49bd45082f28

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