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 917e821348
SDK alpha 1 release (#4903)
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 SDK alpha 1 release (#4903) 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 2nd layer of SDK (#19) 4 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
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git`)

Then import the package:
```python
import {{{packageName}}}
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import {{{packageName}}}
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

{{> README_common }}