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

More docs updates

parent de2378b4
No related branches found
No related tags found
No related merge requests found
...@@ -12,8 +12,17 @@ pip3 install git+https://gitlab.nibio.no/VIPS/vipscore-python-common.git@v0.1.6 ...@@ -12,8 +12,17 @@ pip3 install git+https://gitlab.nibio.no/VIPS/vipscore-python-common.git@v0.1.6
``` ```
...where the version is specified after the `@` ...where the version is specified after the `@`
If you're implementing a VIPS model, typical imports would be
## Unit tests ``` python
from vipscore_common.vips_model import VIPSModel
from vipscore_common.entities import Result, ModelConfiguration, WeatherObservation
from vipscore_common.data_utils import *
```
## Developer guide
### Unit tests
The tests are located in the `tests` folder, and we're using [Pytest](https://docs.pytest.org/) 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: To run the unit tests, move to the root folder of the project, and execute:
...@@ -22,5 +31,17 @@ To run the unit tests, move to the root folder of the project, and execute: ...@@ -22,5 +31,17 @@ To run the unit tests, move to the root folder of the project, and execute:
pytest -v pytest -v
``` ```
## References ### Using bumpver
For developers: When you want to publish a new version, use
``` bash
# Increment the PATCH version when you make backwards compatible bug fixes.
bumpver update --patch
# Increment the MINOR version when you add functionality in a backwards compatible manner.
bumpver update --minor
# Increment the MAJOR version when you make incompatible API changes.
bumpver update --major
```
[(Source)](https://semver.org/#summary)
### References
We used this excellent guide for packaging: https://realpython.com/pypi-publish-python-package/ 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