Merge pull request #8 from ai4os/new-metadata

feat: add new a4-metadata.yml file; fine-tune SQA

VERSION

@@ -1 +1 @@
-2.1.4
+2.1.5

{{ cookiecutter.__repo_name }}/Jenkinsfile

@@ -18,29 +18,37 @@ pipeline {
     post {
         // publish results and clean-up
         always {
-            // file locations are defined in tox.ini
-            // publish results of the style analysis
-            recordIssues(tools: [flake8(pattern: 'flake8.log',
-                                 name: 'PEP8 report',
-                                 id: "flake8_pylint")])
-            // publish results of the coverage test
-            publishHTML([allowMissing: false, 
-                         alwaysLinkToLastBuild: false,
-                         keepAll: true,
-                         reportDir: "htmlcov",
-                         reportFiles: 'index.html',
-                         reportName: 'Coverage report',
-                         reportTitles: ''])
-            // publish results of the security check
-            publishHTML([allowMissing: false, 
-                         alwaysLinkToLastBuild: false,
-                         keepAll: true,
-                         reportDir: "bandit",
-                         reportFiles: 'index.html',
-                         reportName: 'Bandit report',
-                         reportTitles: ''])
+            script {
+                if (fileExists("flake8.log")) {
+                    // file locations are defined in tox.ini
+                    // publish results of the style analysis
+                    recordIssues(tools: [flake8(pattern: 'flake8.log',
+                                         name: 'PEP8 report',
+                                         id: "flake8_pylint")])
+                }
+                if (fileExists("htmlcov/index.html")) {
+                    // publish results of the coverage test
+                    publishHTML([allowMissing: false,
+                                 alwaysLinkToLastBuild: false,
+                                 keepAll: true,
+                                 reportDir: "htmlcov",
+                                 reportFiles: 'index.html',
+                                 reportName: 'Coverage report',
+                                 reportTitles: ''])
+                }
+                if (fileExists("bandit/index.html")) {
+                    // publish results of the security check
+                    publishHTML([allowMissing: false, 
+                                 alwaysLinkToLastBuild: false,
+                                 keepAll: true,
+                                 reportDir: "bandit",
+                                 reportFiles: 'index.html',
+                                 reportName: 'Bandit report',
+                                 reportTitles: ''])
+                }
+            }
             // Clean after build
             cleanWs()
-        }    
+        }
     }
 }

{{ cookiecutter.__repo_name }}/ai4-metadata.yml

@@ -1,23 +1,62 @@
 metadata_version: 2.0.0
 title: {{ cookiecutter.project_name }}
-summary: {{ cookiecutter.description.replace('\'', '') }}
+summary: "{{ cookiecutter.description.replace('\'', '') }}"
 description: |-
-  {{ cookiecutter.project_name }}
+  {{ cookiecutter.__app_name }} is an application using the DEEPaaS API.
   {{ cookiecutter.description.replace('\'', '') }}
+# doi: http://add-some-DOI-url.com
 dates:
-  created: '{% now 'utc', '%Y-%m-%d' %}'
-  updated: '{% now 'utc', '%Y-%m-%d' %}'
+  created: {% now 'utc', '%Y-%m-%d' %}
+  updated: {% now 'utc', '%Y-%m-%d' %}
 links:
   ai4_template: {{ cookiecutter.__ai4_template }}
   source_code: {{ cookiecutter.git_base_url }}/{{ cookiecutter.__repo_name }}
   docker_image: ai4oshub/{{ cookiecutter.__repo_name }}
-#  dataset: 
-tags:
-  - deep learning
-#tasks:
-categories:
-  - AI4 pre trained
-  - AI4 trainable
-  - AI4 inference
-#libraries:
-#data-type:
+  # documentation: http://add-some-documentation.com
+  # dataset: http://add-some-url-pointing-to-your-dataset.com
+  # weights: http://add-some-weights-url.com
+  # citation: http://add-some-DOI-url.com
+  # base_model: http://add-some-link-to-another-model.com
+#tags:        # required property, add user-defined tags that you consider relevant
+  # - deep learning
+#tasks:       # required property, uncomment together with relevant items
+  # - Computer Vision
+  # - Natural Language Processing
+  # - Time Series
+  # - Recommender Systems
+  # - Anomaly Detection
+  # - Regression
+  # - Classification
+  # - Clustering
+  # - Dimensionality Reduction
+  # - Generative Models
+  # - Graph Neural Networks
+  # - Optimization
+  # - Reinforcement Learning
+  # - Transfer Learning
+  # - Uncertainty Estimation
+  # - Other
+#categories:  # required property, uncomment together with relevant items
+  # - AI4 trainable
+  # - AI4 pre trained
+  # - AI4 inference
+  # - AI4 tools
+#libraries:   # required property, uncomment together with relevant items
+  # - TensorFlow
+  # - PyTorch
+  # - Keras
+  # - Scikit-learn
+  # - XGBoost
+  # - LightGBM
+  # - CatBoost
+  # - Other
+#data-type:   # optional, uncomment together with relevant items
+  # - Image
+  # - Text
+  # - Time Series
+  # - Tabular
+  # - Graph
+  # - Audio
+  # - Video
+  # - Other
+

{{ cookiecutter.__repo_name }}/metadata.json

@@ -11,7 +11,7 @@
     ],
     "license": "{{ cookiecutter.open_source_license }}",
     "date_creation": "{% now 'utc', '%Y-%m-%d' %}",
-    "dataset_url": "http://add-some-url-pointing-to-your-dataset.com,
+    "dataset_url": "http://add-some-url-pointing-to-your-dataset.com",
     "sources": {
 		"dockerfile_repo": "{{ cookiecutter.git_base_url }}/{{ cookiecutter.__repo_name }}",
 		"docker_registry_repo": "ai4oshub/{{ cookiecutter.__repo_name }}",

{{ cookiecutter.__repo_name }}/tox.ini

@@ -36,4 +36,4 @@ commands =
 [testenv:qc.sec]
 commands =
   mkdir -p {toxinidir}/bandit
-  bandit -r {{ cookiecutter.__app_name }} -x tests -o {toxinidir}/bandit/index.html
+  bandit -r {{ cookiecutter.__app_name }} -x tests -f html -o {toxinidir}/bandit/index.html