Feature-152-fix-bugs-and-enhance-implementation

CHANGELOG.md

@@ -72,6 +72,7 @@ Here is a template for new release sections
 - Update links in context.json and example.json for all versions [(#167)](https://github.com/OpenEnergyPlatform/oemetadata/pull/167)
 - Restrict the version number to only major and minor versions since 2.0 [(#168)](https://github.com/OpenEnergyPlatform/oemetadata/pull/168)
 - Update all descriptions and examples [(#175)](https://github.com/OpenEnergyPlatform/oemetadata/pull/175)
+- Build scripts use a settings file to share variables [(#177)](https://github.com/OpenEnergyPlatform/oemetadata/pull/177)
 
 ### Removed
 

metadata/latest/build_source/main_schema.json

@@ -23,7 +23,7 @@
             "$ref": "sources.json#"
         },
         "licenses": {
-            "$ref": "licences.json#"
+            "$ref": "licenses.json#"
         },
         "contribution": {
             "$ref": "contribution.json#"

metadata/latest/build_source/schemas/licences.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v20/schemas/licences.json",
+    "$id": "general.json#metadata/v20/schemas/licenses.json",
     "type": "object",
     "properties": {
         "licenses": {

metadata/v20/build_source/schema_structure.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/master/oemetadata/latest/schema.json",
+    "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/develop/metadata/v20/schema.json",
     "description": "Open Energy Platform (OEP) metadata schema latest",
     "type": "object",
     "properties": {
@@ -29,7 +29,7 @@
                         "$ref": "sources.json#"
                     },
                     "licenses": {
-                        "$ref": "licences.json#"
+                        "$ref": "licenses.json#"
                     },
                     "provenance": {
                         "$ref": "provenance.json#"

metadata/v20/build_source/schemas/licences.json → metadata/v20/build_source/schemas/licenses.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v20/schemas/licences.json",
+    "$id": "general.json#metadata/v20/schemas/licenses.json",
     "type": "object",
     "properties": {
         "licenses": {

metadata/v20/build_source/scripts/generate_example_from_schema.py

@@ -12,9 +12,7 @@
 
 # Standard Library Imports
 # import os
-from os.path import dirname
 
-import sys
 import json
 import logging
 
@@ -23,24 +21,12 @@
 # from datetime import datetime
 from pathlib import Path
 
-from jsonschema import validate, ValidationError
+from settings import VERSION_PATH, RESOLVED_SCHEMA_FILE_NAME, EXAMPLE_PATH, LOG_FORMAT
 
 # Configuration
-LOG_FORMAT = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
 logging.basicConfig(level=logging.INFO, format=LOG_FORMAT)
 logger = logging.getLogger(__name__)
 
-# Constants
-BASE_PATH = Path("metadata/")
-VERSION = "v20"
-VERSION_PATH = BASE_PATH / VERSION
-SCHEMA_BUILD_PATH = VERSION_PATH / "build_source"
-MAIN_SCHEMA_PATH = SCHEMA_BUILD_PATH / "schema_structure.json"
-SCHEMA_REFS = SCHEMA_BUILD_PATH / "schemas"
-RESOLVED_SCHEMA_FILE_NAME = VERSION_PATH / "schema.json"
-EXPECTED_SCHEMA_PATH = VERSION_PATH / "schema.json"
-EXAMPLE_PATH = VERSION_PATH / "example.json"
-
 
 def read_schema(filename: str) -> Dict[str, Any]:
     """Read a JSON schema from a file.
@@ -51,7 +37,7 @@ def read_schema(filename: str) -> Dict[str, Any]:
     Returns:
         Dict[str, Any]: The JSON schema as a dictionary.
     """
-    # pwd = dirname(__file__)
+
     with open(VERSION_PATH / filename, "r", encoding="utf-8") as file:
         schema = json.load(file)
     return schema
@@ -120,6 +106,6 @@ def save_json(data: Dict[str, Any], filename: Path) -> None:
 
 
 if __name__ == "__main__":
-    schema_filename = "schema.json"
+    schema_filename = RESOLVED_SCHEMA_FILE_NAME
     json_data = generate_json_from_schema(schema_filename)
     save_json(json_data, EXAMPLE_PATH)

metadata/v20/build_source/scripts/generate_template_from_schema.py

@@ -23,22 +23,14 @@
 
 from jsonschema import validate, ValidationError
 
+
+from settings import RESOLVED_SCHEMA_FILE_NAME, TEMPLATE_PATH, LOG_FORMAT
+
 # Configuration
-LOG_FORMAT = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+
 logging.basicConfig(level=logging.INFO, format=LOG_FORMAT)
 logger = logging.getLogger(__name__)
 
-# Constants
-BASE_PATH = Path("metadata/")
-VERSION = "v20"
-VERSION_PATH = BASE_PATH / VERSION
-SCHEMA_BUILD_PATH = VERSION_PATH / "build_source"
-MAIN_SCHEMA_PATH = SCHEMA_BUILD_PATH / "schema_structure.json"
-SCHEMA_REFS = SCHEMA_BUILD_PATH / "schemas"
-RESOLVED_SCHEMA_FILE_NAME = VERSION_PATH / "schema.json"
-EXPECTED_SCHEMA_PATH = VERSION_PATH / "schema.json"
-TEMPLATE_PATH = VERSION_PATH / "template.json"
-
 
 def generate_template(schema):
     if isinstance(schema, bool):

metadata/v20/build_source/scripts/resolve_schema_refs.py

@@ -11,7 +11,7 @@
 
 requires: "pip install jsonschema referencing"
 
-Usage: Script with additional arguments --debug for more detailed output. 
+Usage: Script with additional arguments --debug for more detailed output.
         Requires the folder structure introduced in oemetadata v2.0.0.
 """
 
@@ -22,28 +22,25 @@
 import logging
 
 # from datetime import datetime
-from pathlib import Path
 from urllib.parse import urljoin
 import argparse
 
 from referencing import Registry, Resource
 from jsonschema import Draft7Validator
 
+from settings import (
+    MAIN_SCHEMA_PATH,
+    SCHEMA_REFS,
+    RESOLVED_SCHEMA_FILE_NAME,
+    EXPECTED_SCHEMA_PATH,
+    LOG_FORMAT,
+)
+
 # Configuration
-LOG_FORMAT = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+
 logging.basicConfig(level=logging.INFO, format=LOG_FORMAT)
 logger = logging.getLogger(__name__)
 
-# Constants
-BASE_PATH = Path("metadata/")
-VERSION = "v20"
-VERSION_PATH = BASE_PATH / VERSION
-SCHEMA_BUILD_PATH = VERSION_PATH / "build_source"
-MAIN_SCHEMA_PATH = SCHEMA_BUILD_PATH / "schema_structure.json"
-SCHEMA_REFS = SCHEMA_BUILD_PATH / "schemas"
-RESOLVED_SCHEMA_FILE_NAME = VERSION_PATH / "schema.json"
-EXPECTED_SCHEMA_PATH = VERSION_PATH / "schema.json"
-
 
 # Function Definitions
 def setup():

metadata/v20/build_source/scripts/settings.py

@@ -0,0 +1,16 @@
+from pathlib import Path
+
+LOG_FORMAT = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+
+BASE_PATH = Path("metadata/")
+VERSION = "v20"
+VERSION_PATH = BASE_PATH / VERSION
+SCHEMA_BUILD_PATH = VERSION_PATH / "build_source"
+MAIN_SCHEMA_PATH = SCHEMA_BUILD_PATH / "schema_structure.json"
+SCHEMA_REFS = SCHEMA_BUILD_PATH / "schemas"
+RESOLVED_SCHEMA_FILE_NAME = VERSION_PATH / "schema.json"
+EXPECTED_SCHEMA_PATH = VERSION_PATH / "schema.json"
+
+EXAMPLE_PATH = VERSION_PATH / "example.json"
+
+TEMPLATE_PATH = VERSION_PATH / "template.json"