diff --git a/README.md b/README.md index 241ae85e0bb8be2def1de09c430fa99bd7193e75..087dd065c85c980013a5b928fd41bfde1362f020 100644 --- a/README.md +++ b/README.md @@ -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 `@` +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/) 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 ``` -## 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/ \ No newline at end of file