fix: update comments from Russian to English for better clarity

Author: nookyo

README.md

@@ -28,7 +28,7 @@ pip install .
 
 The `generate` command creates an application manifest based on a [configuration file](./example/jaeger/qubership-jaeger-am-build.yaml) and, if needed, [additional component files](./example/jaeger/).
 
-### Синтаксис
+### Syntax
 
 ```bash
 python -m venv venv

src/app_manifest_cli/commands/generate.py

@@ -28,18 +28,18 @@ def generate_command(
         if out == None:
             out = name + '-' + version + '.json'
         body = create_command(name=name, version=version, out=open(out, "w"))
-        # Получаю компоненты из конфига -- именно они определяют состав манифеста
+        # Get components from config -- they define the manifest composition
         config_components = get_components_from_data(configuration_data)
-        # Получаю депенденси из конфига
+        # Get dependencies from config
         config_dependencies = load_dependencies(config_components)
-        # Читаю все json файлы с компонентами
+        # Read all JSON files with components
         json_components = []
         if components_files:
             for json_path in components_files:
                 with open(json_path.resolve(), "r", encoding="utf-8") as f:
                     json_comp = json.load(f)
                     json_components.append(json_comp)
-        # Перебираю компоненты из конфига, если в json_components есть такой же, то обновляю его
+        # Iterate through components from config, if the same exists in json_components, then update it
         components = []
         for conf_comp in config_components:
             conf_comp['mime-type'] = conf_comp["mimeType"]
@@ -52,24 +52,24 @@ def generate_command(
                 conf_comp["bom-ref"] = get_bom_ref(conf_comp["name"])
             components.append(conf_comp)
 
-        # Генерирую дополнительные метаданные для helm chart
-        #   добавляю properies с именем qubership:helm.values.artifactMappings
-        #   и значением в виде dict, где ключ - bom-ref зависимости, а значение - dict с ключом valuesPathPrefix и значением из конфигурации
+        # Generate additional metadata for helm chart
+        #   add properties named qubership:helm.values.artifactMappings
+        #   with value as a dict, where key is bom-ref of dependency, and value is a dict with valuesPathPrefix key and value from configuration
 
         components = generate_helm_values_artifact_mappings(components)
-        # Если включено discovery, то запускаю его
-        # дополняя компоненты зависимостями и свойствами
+        # If discovery is enabled, run it
+        # enriching components with dependencies and properties
         # if discovery:
         components = helm_discovery(components)
-        # Добавляю все компоненты в манифест
+        # Add all components to the manifest
         for comp in components:
             if comp.get("mime-type") == "application/vnd.qubership.standalone-runnable":
                 if comp.get("version", "") == "":
                     comp["version"] = version
             typer.echo(f"Adding component: {comp['name']} with mime-type: {comp['mime-type']}")
             #typer.echo(f"comp details: {json.dumps(comp, indent=2)}")
             _add_component(manifest_path=out, payload_text=json.dumps(obj=comp,sort_keys=True), out_file=None)
-        # Формирую простой список компонент для удобства поиска
+        # Form a simple list of components for easy search
         components_list = [ comp["mime-type"] + ":" + comp["name"] for comp in components]
         for dep in config_dependencies:
             dep_record = {}
@@ -117,11 +117,11 @@ def load_configuration(configuration: str) -> dict:
     #     raise ValueError("Configuration file must contain 'dependencies' section")
     return configuration_data
 
-# Здесь я предполагаю, что в конфиге dependencies описываются внутри каждого компонента
-# в виде списка dependsOn, где каждый элемент содержит name и mime-type
-# Преобразую это в список словарей с ключами name, ref и dependsOn
-# ref - это mime-type:name
-# dependsOn - это список ref зависимостей
+# Here I assume that in the config dependencies are described inside each component
+# in the form of dependsOn list, where each element contains name and mime-type
+# Transform this into a list of dictionaries with keys name, ref and dependsOn
+# ref is mime-type:name
+# dependsOn is a list of dependency refs
 def load_dependencies(config_data: dict) -> List:
     deps = []
     for comp in config_data:
@@ -139,15 +139,15 @@ def load_dependencies(config_data: dict) -> List:
             deps.append({"name": deps_elem_name, "ref": deps_elem_ref, "dependsOn": deps_elem_depends_on})
     return deps
 
-# Функция, которая получает на вход список компонент из манифеста (чтобы найти bom-ref по имени)
-# Что она делает:
-# 1. если mime-type компоненты == application/vnd.qubership.helm.chart
-# 2. если у компонента есть dependsOn, то перебирает все зависимости и проверяет есть ли у каждой зависимости параметр valuesPathPrefix
-# 3. если есть, то создаёт dict с ключами:
-# "name": "qubership:helm.values.artifactMappings" и
-# "value": {"bom-ref зависимости": {"valuesPathPrefix": "значение из зависимости"}, ...}
-# 4. добавляет этот dict в properties компонента
-# 5. возвращает обновлённый список компонентов
+# Function that receives a list of components from the manifest (to find bom-ref by name)
+# What it does:
+# 1. if component mime-type == application/vnd.qubership.helm.chart
+# 2. if the component has dependsOn, iterate through all dependencies and check if each dependency has valuesPathPrefix parameter
+# 3. if yes, create a dict with keys:
+# "name": "qubership:helm.values.artifactMappings" and
+# "value": {"dependency bom-ref": {"valuesPathPrefix": "value from dependency"}, ...}
+# 4. add this dict to component properties
+# 5. return the updated list of components
 def generate_helm_values_artifact_mappings(manifest_components: List[dict]) -> dict | None:
     components = []
     for component in manifest_components:
@@ -162,7 +162,7 @@ def generate_helm_values_artifact_mappings(manifest_components: List[dict]) -> d
             if "valuesPathPrefix" in dep:
                 dep_name = dep.get("name")
                 dep_mime = dep.get("mimeType", dep.get("mime-type"))
-                # Ищу в manifest_components компонент с таким же name и mime-type, чтобы взять его bom-ref
+                # Search in manifest_components for a component with the same name and mime-type to get its bom-ref
                 matching_comp = next((comp for comp in manifest_components if comp["name"] == dep_name and comp["mime-type"] == dep_mime), None)
                 print(f"  Processing dependency: {dep_name}, found matching component: {matching_comp is not None}")
                 if matching_comp and "bom-ref" in matching_comp:

src/app_manifest_cli/handlers/docker_handler.py

@@ -3,7 +3,7 @@
 
 def handle(obj: dict) -> dict:
 
-    # DAO Тут можно добавить логику обработки входящего json  Docker Image
+    # DAO Here you can add logic for processing incoming json Docker Image
     DOCKER_REQUIRED_FIELDS = ["type",
         "mime-type",
         "bom-ref",
@@ -33,7 +33,7 @@ def handle(obj: dict) -> dict:
         if field not in obj:
             raise ValueError(f"Missing required field '{field}' in docker image component")
     #print("Running docker_image handler")
-    # удаляю лишние поля из obj
+    # Remove extra fields from obj
     for field in list(obj.keys()):
         if field not in DOCKER_FIELDS:
             print(f"  Warning: Unknown field '{field}' in docker image component")

src/app_manifest_cli/handlers/helm_handler.py

@@ -3,7 +3,7 @@
 
 def handle(obj: dict) -> dict:
 
-    # DAO Тут можно добавить логику обработки входящего json Helm Chart
+    # DAO Here you can add logic for processing incoming json Helm Chart
     CHART_REQUIRED_FIELDS = [
         "type",
         "mime-type",

src/app_manifest_cli/handlers/standalone_runnable_handler.py

@@ -2,7 +2,7 @@
 
 def handle(obj: dict) -> dict:
 
-    # DAO Тут можно добавить логику обработки входящего json standalone-runnable
+    # DAO Here you can add logic for processing incoming json standalone-runnable
     STANDALONE_RUNNABLE_REQUIRED_FIELDS = [
         "type",
         "mime-type",

src/app_manifest_cli/services/helm_discovery.py

@@ -7,16 +7,16 @@
 from typing import List
 from ..commands.create import get_bom_ref
 from ..services.purl_url import url_2_purl
-# Здесь должны быть методы для работы с helm chart
-# для генерации дополнительных метаданных
-# На входе получаем url чарта
-# командами helm скачиваем чарт
-# распаковываем его
-# 1. Читаем Chart.yaml, чтобы:
-# - узнать его type, если type: library, то добавляем в манифест property isLibrary=true
-# - узнать, есть ли у него dependencies, если есть, то для каждой зависимости добавляем вложенную component в компоненту этого чарта в манифесте
-# 2. Проверяем,есть ли в чарте файл с именем values.schema.json
-# если есть, то шифруем файл в base64 и добавляем в component чарта вложенный объект
+# Here should be methods for working with helm charts
+# for generating additional metadata
+# Input: chart url
+# Download chart using helm commands
+# Unpack it
+# 1. Read Chart.yaml to:
+# - determine its type, if type: library, then add property isLibrary=true to manifest
+# - determine if it has dependencies, if yes, for each dependency add a nested component to this chart's component in manifest
+# 2. Check if the chart has a file named values.schema.json
+# if yes, encode the file in base64 and add a nested object to the chart component
 #       "components": [
 #        {
 #          "bom-ref": "qubership-jaeger-values-schema:7f17a6dc-b973-438f-abb7-e0c57a32afc5",
@@ -65,14 +65,14 @@
 # def helm_discovery(components: List) -> List:
 #     if components is None:
 #         return {}
-#     # Проверяю, что helm установлен
+#     # Check that helm is installed
 #     try:
 #         subprocess.run("helm version", shell=True, text=True, check=True, capture_output=True)
 #     except subprocess.CalledProcessError as e:
 #         print("Helm is not installed or not found in PATH. Please install Helm to use helm discovery.", file=sys.stderr)
 #         return components
 #     print("Helm is installed, proceeding with helm discovery.")
-#     # Иду по всем компонентам, у которых mime-type application/vnd.qubership.helm.chart
+#     # Iterate through all components with mime-type application/vnd.qubership.helm.chart
 #     for comp in [f for f in components if f['mime-type'] == 'application/vnd.qubership.helm.chart']:
 #         chart = single_chart_discovery(comp)
 #         comp.update(chart)
@@ -91,7 +91,7 @@ def helm_discovery(components: List) -> List:
     charts = [f for f in components if f['mime-type'] == 'application/vnd.qubership.helm.chart']
     with concurrent.futures.ThreadPoolExecutor() as executor:
         results = list(executor.map(single_chart_discovery, charts))
-    # Обновляем компоненты результатами
+    # Update components with results
     chart_names = {c['name'] for c in charts}
     for i, comp in enumerate(components):
         if comp['name'] in chart_names:
@@ -100,15 +100,15 @@ def helm_discovery(components: List) -> List:
 
 def single_chart_discovery(chart: dict) -> dict:
         try:
-            # делаю директорию для скачивания чарта с рандомным именем
+            # Create directory for downloading chart with random name
             chart_dir = f"chart-{os.urandom(4).hex()}"
             os.makedirs(chart_dir, exist_ok=True)
             if chart.get("mime-type") != "application/vnd.qubership.helm.chart":
                 print(f"Component {chart['name']} isn't a chart.")
                 return chart
             if not chart['reference']:
                 raise ValueError("Helm chart component must have reference")
-            # Тут должна быть логика скачивания чарта по purl, распаковки и чтения файлов
+            # Here should be the logic for downloading chart by purl, unpacking and reading files
             chart_url = chart["reference"]
             print(f"Discovering helm chart: {chart['name']} with reference: {chart['reference']}")
             try:
@@ -126,7 +126,7 @@ def single_chart_discovery(chart: dict) -> dict:
                 chart["properties"] = []
             chart["properties"].append({"name": "isLibrary", "value": chart_info.get("type") == "library"})
 
-            # Проверяю наличие dependencies
+            # Check for dependencies
             if "dependencies" not in chart_info:
                 print(f"No dependencies found in chart {chart['name']}")
                 # continue
@@ -146,7 +146,7 @@ def single_chart_discovery(chart: dict) -> dict:
                     "properties": [],
                     "components": []
                 })
-            # Проверяю наличие values.schema.json
+            # Check for values.schema.json
             if os.path.isfile(os.path.join(chart_dir, chart['name'], "values.schema.json")):
                 with open(os.path.join(chart_dir, chart['name'], "values.schema.json"), 'rb') as f:
                     encoded_content = base64.b64encode(f.read()).decode('utf-8')
@@ -169,7 +169,7 @@ def single_chart_discovery(chart: dict) -> dict:
                         }
                     }]
                 })
-            # Проверяю наличие resource-profiles directory
+            # Check for resource-profiles directory
             resource_profiles_path = os.path.join(chart_dir, chart['name'], "resource-profiles")
             if os.path.isdir(resource_profiles_path):
                 profile_files = [f for f in os.listdir(resource_profiles_path) if os.path.isfile(os.path.join(resource_profiles_path, f)) and f.endswith(('.yaml', '.yml', '.json'))]
@@ -203,7 +203,7 @@ def single_chart_discovery(chart: dict) -> dict:
         except Exception as e:
             print(f"Error processing helm chart component {chart.get('name', 'unknown')}: {e}", file=sys.stderr)
         finally:
-            # Удаляю директорию чарта
+            # Delete chart directory
             if os.path.isdir(chart_dir):
                 subprocess.run(f"rm -rf {chart_dir}", shell=True)
         return chart

src/app_manifest_cli/services/standalone_runnable.py

@@ -1,8 +1,8 @@
-# Здесь происходит наполнение данных о компоненте с mime-type application/vnd.qubership.standalone-runnable
-# Входные данные:
-# - путь к каталогу с файлами конфигурации (.yaml или .yml или .json)
-# - dict компоненты, в которую нужно добавить вложенные объекты с конфигурациями
-# Выходные данные: dict вида
+# Here the data is populated for a component with mime-type application/vnd.qubership.standalone-runnable
+# Input data:
+# - path to directory with configuration files (.yaml or .yml or .json)
+# - component dict to which nested objects with configurations need to be added
+# Output data: dict of the form
     # {
     #   "bom-ref": "qubership-jaeger:61439aff-c00d-43f5-9bae-fe6db05db2d5",
     #   "type": "application",