You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Roman Donchenko 4c32be5c9b
Fix the documentation build (#5704)
In #5678, I thought that the extra README that eventually ended up in
`cvat-sdk/docs/README.md` was unused, which turned out to be not quite
true. One section from it _was_ used to generate the online API index
page. Since I removed the file, the online docs now fail to build.

Rather than restore the entire README, restore just that one section as
a standalone file. This achieves the same result as before, but with
simpler code.
3 years ago
..
cvat_sdk SDK: Remove unused module (#5695) 3 years ago
gen Fix the documentation build (#5704) 3 years ago
requirements Various improvements to the SDK generation process (#5678) 3 years ago
.gitignore Various improvements to the SDK generation process (#5678) 3 years ago
.openapi-generator-ignore Various improvements to the SDK generation process (#5678) 3 years ago
.remarkignore Various improvements to the SDK generation process (#5678) 3 years ago
MANIFEST.in Various improvements to the SDK generation process (#5678) 3 years ago
README.md Various improvements to the SDK generation process (#5678) 3 years ago
pyproject.toml Add 2nd layer of SDK (#19) 4 years ago

README.md

SDK for Computer Vision Annotation Tool (CVAT)

This package provides a Python client library for CVAT server. It can be useful for workflow automation and writing custom CVAT server clients.

The SDK API includes 2 layers:

  • Server API wrappers (ApiClient). Located in at cvat_sdk.api_client
  • High-level tools (Core). Located at cvat_sdk.core

Package documentation is available here.

Installation & Usage

To install a prebuilt package, run the following command in the terminal:

pip install cvat-sdk

To install from the local directory, follow the developer guide.

After installation you can import the package:

import cvat_sdk