Merge pull request #34 from adaa-polsl/develop

v2.1.21.0

Author: cezary986

.gitignore

@@ -294,4 +294,6 @@ classification_tabular_datasets/
 .coverage
 junit.xml
 a.ipynb
-java.logs
+java.logs
+do_arta/
+tutorials_env/

docs/HOW_TO_DEPLOY.md

@@ -1,9 +1,21 @@
 # Deployment instruction
 
-> Don't forger to change version before deployment!
 > Deployment **MUST** be done from the `main` branch only!
 
-### 1. Create tag in Github repository 
+## 1. Change version
+
+Version is stored in few places (unfortunately):
+* `main.py` file, `__RULEKIT_RELEASE_VERSION__` variable should be set to the *.jar version of the RuleKit library used by this specific package version
+* `main.py` file, `__VERSION__` variable specify additional version number which should be elevated only when given release includes changes in Python but still uses the same *.jar version as the last existing release. 
+* `setup.py` version should be the same as `__VERSION__` in `main.py` file
+
+To sum up:
+* If you migrate to new *.jar file -> change `__RULEKIT_RELEASE_VERSION__` and version in `setup.py`
+* If you change something in the package itself and continue to use the same version of RuleKit jar file -> bump only the last number of `__VERSION__`
+
+> ⚠️ **Always update version in `setup.py` to match `__VERSION__` from the `main.py` file!**
+
+### 2. Create tag in Github repository 
 Create tag on current commit named `v{CURRENT_VERSION}`
 
 ### 2. Create release in Github

docs/badges/coverage-badge.svg

@@ -70,8 +70,8 @@ def main():
     print('Updating badges')
     cwd = pathlib.Path(curr_dir_path / '..')  # root repo dir
 
-    generate_tests_coverage_badge(cwd)
-    generate_test_badge(cwd)
+    # generate_tests_coverage_badge(cwd)
+    # generate_test_badge(cwd)
     generate_flake8_badge(cwd)
 
     print('Badges generated successfully!')

docs/badges/flake8-badge.svg

@@ -11,8 +11,9 @@ def run_command(command: list[str], cwd: Optional[str] = None, raise_on_error: b
     )
     output, error = process.communicate()
     if process.returncode != 0 and raise_on_error:
-        raise Exception("File handling failed %d %s %s" %
-                        (process.returncode, output, error)
+        print(error.decode())
+        raise Exception("Command run failed %d %s" %
+                        (process.returncode, error)
                         )
 
     print(output.decode())