Skip to main content

Browse the archive

Revision f2748a6cc37dae520c41e5b54568313dce8fa65c authored by Anders Eknert on 26 October 2023, 07:02:43 UTC, committed by GitHub on 26 October 2023, 07:02:43 UTC 
Add Regal for linting Rego (#7038)
 
Hello CVAT friends! 👋😃

This PR introduces [Regal](https://github.com/styrainc/regal)) for
linting the Rego included in this project. The policy code here is
generally in a really good shape, so the linter did not have too much to
do. Good work on that!

Violations of a few rules were fixed as part of this PR, as they do not
change the semantics of evaluation:

* [line-length](https://docs.styra.com/regal/rules/style/line-length)
*
[unconditional-assignment](https://docs.styra.com/regal/rules/style/unconditional-assignment)
*
[use-assignment-operator](https://docs.styra.com/regal/rules/style/use-assignment-operator)

A few other ones were ignored using Regal's configuration file. Whether
some of them should be fixed in the future I'll leave up to the
project's maintainers.

I've also added Regal as a build workflow, along with some
documentation. Let me know if I missed anything!


Signed-off-by: Anders Eknert <anders@styra.com>
1 parent e0d1343
Raw File
README.md 
# 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

```bash
$ 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:

```bash
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:

```bash
cvat-cli --auth admin:password \
    --server-host cvat.my.server.com --server-port 30123 \
    ls
```
back to top