Skip to content
This repository has been archived by the owner on Nov 14, 2023. It is now read-only.

Commit

Permalink
Update REST API tests documentation (cvat-ai#5993)
Browse files Browse the repository at this point in the history
  • Loading branch information
yasakova-anastasia authored and mikhail-treskin committed Jul 1, 2023
1 parent e7a78f9 commit 0b39906
Showing 1 changed file with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions tests/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,28 @@ Also it is worth to have a real instance with real data inside and tests
the server calling REST API directly (as it done by users).

## How to run?
**Initial steps**

1. After that please look at documentation for [pytest](https://docs.pytest.org/en/6.2.x/).
Generally, you have to install requirements and run the following command from
the root directory of the cloned CVAT repository:

```console
pip install -e cvat-sdk/
pip install -e cvat-cli/
pip install -r tests/python/requirements.txt
pytest tests/python/
1. Follow [this guide](/site/content/en/docs/api_sdk/sdk/developer-guide/) to prepare
`cvat-sdk` and `cvat-cli` source code
1. Install all necessary requirements before running REST API tests:
```
pip install -r ./tests/python/requirements.txt
pip install -e ./cvat-sdk
pip install -e ./cvat-cli
```
1. Stop any other CVAT containers which you run previously. They keep ports
which are used by containers for the testing system.

**Running tests**

Run all REST API tests:

```
pytest ./tests/python
```

This command will automatically start all necessary docker containers.

See the [contributing guide](../../site/content/en/docs/contributing/running-tests.md)
to get more information about tests running.
Expand Down

0 comments on commit 0b39906

Please sign in to comment.