Skip to content
Snippets Groups Projects
Commit 7411c06d authored by Tor-Einar Skog's avatar Tor-Einar Skog
Browse files

Docs update

parent 0a724b5e
No related branches found
No related tags found
No related merge requests found
......@@ -2,19 +2,25 @@
# VIPSCore-Python-Common
This is the source code for the module that contains the common data models and utilities for the Python implementation(s) of VIPS. It can be imported with pip like this:
This is the source code for the module that contains the common data models and utilities for the Python implementation(s) of VIPS. It can be installed with pip like this:
``` bash
pip3 install TODOTODOTODO
# From local path, if you've cloned the Git repo
pip3 install /home/foo/vipscore-python-common/
# From GitLab
pip3 install git+https://gitlab.nibio.no/VIPS/vipscore-python-common.git@v0.6.3
```
...where the version is specified after the `@`
## Unit tests
The tests are located in the `src/vipscore_common/tests` folder, and we're using Python's standard [`unittest` library](https://docs.python.org/3/library/unittest.html)
The tests are located in the `tests` folder, and we're using [Pytest](https://docs.pytest.org/)
To run the unit tests, move to the root folder of the project, and execute:
``` bash
python3 -m unittest discover -s tests -t src/vipscore_common
```
\ No newline at end of file
pytest -v
```
## References
We used this excellent guide for packaging: https://realpython.com/pypi-publish-python-package/
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment