From a6d09a01323e76cf7d746aa0b0c630de0dce978b Mon Sep 17 00:00:00 2001 From: Andrea Franchini <hello@andreafranchini.com> Date: Mon, 27 Feb 2023 17:36:30 +0100 Subject: [PATCH] update readme and version --- README.md | 14 ++++++-------- mc_openapi/__init__.py | 2 +- mc_openapi/doml_mc/xmi_parser/doml_model.py | 4 ++-- 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index bee90ba..4c4b860 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ [](https://piacere-model-checker.readthedocs.io/en/latest/?badge=latest) # PIACERE Model Checker -_______________________ -## **You can read the [docs here](https://piacere-model-checker.readthedocs.io/en/latest/) for more details.** -_______________________ + +**📖 You can read the [docs here](https://piacere-model-checker.readthedocs.io/en/latest/) for more details. 📖** The DOML Model Checker is a component of the [PIACERE](https://www.piacere-project.eu/) framework in charge of checking the correctness and consistency of @@ -15,7 +14,7 @@ in charge of checking the correctness and consistency of If you add a new package, regenerate it by running: ```sh - poetry run pip freeze > requirements.txt + pip freeze > requirements.txt ``` ## Setup @@ -59,7 +58,7 @@ And then run it with docker run -d wp4/dmc ``` The Uvicorn server will be running and listening on port 80 of the container. -To use it locally, you may e.g. bind it with port 8080 of `localhost` +To use it locally, you may bind it with port `8080` of `localhost` by adding `-p 127.0.0.1:8080:80/tcp` to the `docker run` command. @@ -67,10 +66,9 @@ by adding `-p 127.0.0.1:8080:80/tcp` to the `docker run` command. The documentation has been written in [Sphinx](https://www.sphinx-doc.org/) and covers both usage through the PIACERE IDE and the REST APIs. +You can read the latest version at [readthedocs.io](https://piacere-model-checker.readthedocs.io/en/latest/) -Read it at [readthedocs.io](https://piacere-model-checker.readthedocs.io/en/latest/) - -Build the documentation with: +If you want to build the documentation manually, run: ```sh cd docs make html diff --git a/mc_openapi/__init__.py b/mc_openapi/__init__.py index 58d478a..a33997d 100644 --- a/mc_openapi/__init__.py +++ b/mc_openapi/__init__.py @@ -1 +1 @@ -__version__ = '1.2.0' +__version__ = '2.1.0' diff --git a/mc_openapi/doml_mc/xmi_parser/doml_model.py b/mc_openapi/doml_mc/xmi_parser/doml_model.py index 263c6bf..7866e34 100644 --- a/mc_openapi/doml_mc/xmi_parser/doml_model.py +++ b/mc_openapi/doml_mc/xmi_parser/doml_model.py @@ -60,9 +60,9 @@ def infer_domlx_version(raw_model: bytes) -> DOMLVersion: else: raise RuntimeError(f"Supplied with DOMLX model of unsupported version {v_str}") else: - return DOMLVersion.V2_0 # Should be DOMLVersion.V1_0, but we use V2_0 because the 2.0 IDE doesn't fill it + return DOMLVersion.V2_0 # Should be DOMLVersion.V1_0, but we use V2_0 because the 2.1 IDE doesn't fill it else: - raise RuntimeError("Supplied with malformed DOMLX model.") + raise RuntimeError(f"Supplied with malformed DOMLX model or unsupported DOML version.\nIn use version is: {DOMLVersion.V2_1}") def parse_doml_model(raw_model: bytes, doml_version: Optional[DOMLVersion]) -> Tuple[IntermediateModel, DOMLVersion]: -- GitLab