From 41ee1eebb1339e872ad2be4b476b3c258bfe787a Mon Sep 17 00:00:00 2001 From: Tor-Einar Skog <tor-einar.skog@nibio.no> Date: Wed, 1 Feb 2023 14:31:26 +0100 Subject: [PATCH] Docs update --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cada388..8a3af2d 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ ## How to find and instantiate this model TODO: Must find a way of dynamically importing models +Clues here: https://stackoverflow.com/questions/42401495/how-to-dynamically-import-modules#42402095 + ``` python >>> from reference_model import reference_model >>> from vipscore_common.vips_model import VIPSModel @@ -18,4 +20,16 @@ TODO: Must find a way of dynamically importing models >>> t.get_model_description() "\n The model is a reference model for developers, showcasing best practices and functionalities of a model.\n It's a simple day degree model for an imagined pest, and when thresholds are passed, the warning status progresses.\n " -``` \ No newline at end of file +``` + +## Testing +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 +pytest -v +``` + +## References +We used this excellent guide for packaging: https://realpython.com/pypi-publish-python-package/ \ No newline at end of file -- GitLab