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.
Maxim Zhiltsov 68375ec23e
Add SDK docs (#4928)
- Added auth docs in API schema and SDK ApiClient/Config (fixes #1517)
- Added SDK docs with API, SDK and CLI docs
- Added `develop` branch in the docs
- Allowed unauthorized access to `api/docs`, `api/swagger`, `api/schema` endpoints
- Added `--insecure` env var to control host checks in CLI
- Refactored `build_docs.py` (backported https://github.com/openvinotoolkit/datumaro/pull/589)
- Extracted requirements file for site
3 years ago
..
model_templates SDK layer 2 - cover RC1 usecases (#4813) 4 years ago
.openapi-generator-ignore Add 2nd layer of SDK (#19) 4 years ago
README.mustache Add SDK docs (#4928) 3 years ago
README_common.mustache SDK alpha 1 release (#4903) 3 years ago
__init__.mustache Add CVAT SDK package (#7) 4 years ago
__init__api.mustache Add CVAT SDK package (#7) 4 years ago
__init__apis.mustache Add CVAT SDK package (#7) 4 years ago
__init__model.mustache Add CVAT SDK package (#7) 4 years ago
__init__models.mustache Add 2nd layer of SDK (#19) 4 years ago
__init__package.mustache Add 2nd layer of SDK (#19) 4 years ago
api.mustache Add 2nd layer of SDK (#19) 4 years ago
api_client.mustache SDK layer 2 - cover RC1 usecases (#4813) 4 years ago
api_name.mustache Add CVAT SDK package (#7) 4 years ago
configuration.mustache Add SDK docs (#4928) 3 years ago
model.mustache SDK layer 2 - cover RC1 usecases (#4813) 4 years ago
model_utils.mustache SDK layer 2 - cover RC1 usecases (#4813) 4 years ago
operation_name.mustache Add CVAT SDK package (#7) 4 years ago
partial_header.mustache Add CVAT SDK package (#7) 4 years ago
rest.mustache Add 2nd layer of SDK (#19) 4 years ago
return_type.mustache Add CVAT SDK package (#7) 4 years ago
setup.mustache Add 2nd layer of SDK (#19) 4 years ago

README.mustache

# {{{projectName}}}
{{#appDescriptionWithNewLines}}
{{{.}}}
{{/appDescriptionWithNewLines}}

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: {{appVersion}}
- Package version: {{packageVersion}}
{{^hideGenerationTimestamp}}
- Build date: {{generatedDate}}
{{/hideGenerationTimestamp}}
- Build package: {{generatorClass}}
{{#infoUrl}}
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
{{/infoUrl}}

## Installation & Usage

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

```sh
pip install cvat-sdk
```

To install from the local directory, follow [the developer guide](https://opencv.github.io/cvat/docs/integration/sdk/developer_guide).

After installation you can import the package:

```python
import cvat_sdk
```

## Getting Started

{{> README_common }}