Skip to content

Commit 4981e25

Browse files
authored
Small improvements to test instructions (#192)
1 parent 9858c62 commit 4981e25

File tree

2 files changed

+31
-15
lines changed

2 files changed

+31
-15
lines changed

README.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,4 @@ We welcome contributions. Please see [`Building`](./documentation/Building.md) f
4040
development-build instructions. For large new
4141
features, please open an issue to discuss goals and approach in order
4242
to ensure a smooth PR integration and review process. All contributions
43-
must be licensed under the repository's [MIT License](./LICENSE).
44-
45-
# Testing
46-
47-
* Unit tests: `pytest`
48-
* Demo notebooks:
49-
* ```
50-
pip install -r test/ipynb/requirements.txt
51-
pytest --nbmake test/ipynb
52-
```
53-
* Credentials:
54-
* Some tests run on TileDB Cloud using your current environment variable `TILEDB_REST_TOKEN` -- you will need a valid API token for the tests to pass
55-
* For continuous integration, the token is configured for the `unittest` user and all tests should pass
43+
must be licensed under the repository's [MIT License](./LICENSE).

documentation/Building.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,38 @@ pip install git+https://github.com/TileDB-Inc/TileDB-Vector-Search.git#subdirect
88
```
99

1010
## Installation from a local checkout:
11-
```
11+
```bash
1212
cd apis/python
1313
pip install .
1414
```
15+
16+
# Testing
17+
18+
You can run unit tests with `pytest`. You'll also need to install the test dependencies:
19+
```bash
20+
cd apis/python
21+
pip install ".[test]"
22+
```
23+
Then you can run the tests:
24+
```bash
25+
cd apis/python
26+
# To run all tests.
27+
pytest
28+
# To run a single test and display standard output and standard error.
29+
pytest test/test_ingestion.py -s
30+
```
31+
32+
To test Demo notebooks:
33+
```bash
34+
cd apis/python
35+
pip install -r test/ipynb/requirements.txt
36+
pytest --nbmake test/ipynb
37+
```
38+
39+
Credentials:
40+
* Some tests run on TileDB Cloud using your current environment variable `TILEDB_REST_TOKEN` - you will need a valid API token for the tests to pass. See [Create API Tokens](https://docs.tiledb.com/cloud/how-to/account/create-api-tokens) for for instructions on getting one.
41+
* For continuous integration, the token is configured for the `unittest` user and all tests should pass.
42+
1543
# Dependencies
1644

1745
## Linux
@@ -22,7 +50,7 @@ apt-get openblas-dev build-essentials cmake3
2250
```
2351

2452
To build the python API after you have the dependencies, use pip:
25-
```
53+
```bash
2654
cd apis/python
2755
pip install .
2856
```

0 commit comments

Comments
 (0)