Python SDK Support

[manoj130]

I want to interact with CVAT in local server and docker with CMD using python script
is there a stable python API to create and upload and download data from CVAT

[bsekachev]

Hello,

We have only a CLI interface (https://github.com/openvinotoolkit/cvat/tree/develop/utils/cli), but actually it is not well spported and may not to work time to time.
You can consider CVAT REST API as a quite stable and write a simple Python wrapper around it. Generally, having such SDK is a good idea, I believe.

[zhiltsov-max]

Hi. No, there is no dedicated library for this yet. I think, we could add such SDK in future. Do you have any specific requests about its functionality? Basically it could duplicate the CLI functionality.

[manoj130]

All i want to do is integrate this Cvat tool to my code and get access of annotations to a variable level

[nmichlo]

An official python API that matches the REST API would be an excellent feature. It would make development of many tasks much quicker too.

EDIT: could use the open api generator: https://github.com/OpenAPITools/openapi-generator#openapi-generator

Export the json definitions, and save them as cvat_api.json:

http://<url>/api/schema?scheme=json

Then create the API:

docker run --rm \
    -v "${PWD}:/local" openapitools/openapi-generator-cli generate \
    -i /local/cvat_api.json \
    -g python \
    -o /local/cvat_api

[dasturge]

@nmichlo any other way I could get the schema? This doesn't seem to work on my instance, I get "The requested resource was not found on this server"

[nmichlo]

@dasturge Try starting your own CVAT instance locally?

git clone https://github.com/openvinotoolkit/cvat
cd cvat
docker-compose -f docker-compose.yml -f components/serverless/docker-compose.serverless.yml up
docker exec -it cvat bash -ic 'python3 ~/manage.py createsuperuser'

Make sure to login at http://localhost:8080 before visiting http://localhost:8080/api/schema/?scheme=json

---

One thing I have noticed is that the returned schema from CVAT seems wrong. The generator is not able to generate a valid CLI, you need to go in and make manual changes to get it working.

[dasturge]

@nmichlo I tried these steps and they did not work for me. Still "The requested resource was not found on this server".

[zhiltsov-max]

Hi, we have published cvat-cli package on PyPI. Install with pip install cvat-cli.