Merge pull request #20 from shuva10v/main

Adding icons

.github/workflows/validate.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.7]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Run Tests
+        run: |
+          python validate.py test

README.md

@@ -28,6 +28,12 @@ must contain all possible interactions and unique off-chain analytics tag.
 scoring formula, etc..
 * [ScoreModel](./models/scores.py) - final formula to get scores for each project based on metrics
 
+Every project must have an icon, icon must be present in the [projects/icons](projects/icons) folder.
+Icon name template is ``{leaderboard}_{project_name}.{extension}``, where:
+* __leaderboard__ - value from ``SeasonConfig.leaderboard``
+* __project_name__ - project name (``Project.name``), in lower-case
+* __extension__ - svg or png. In case of png size must be 100x100 px.
+
 ## Season
 
 List of the seasons supported with the leaderboard links

models/icons.py

@@ -0,0 +1,16 @@
+import glob
+import os
+
+from models.season_config import SeasonConfig
+
+
+def get_icon_name(config: SeasonConfig, project: any):
+    # start with detecing icon extension
+    prefix = config.leaderboard + "_" + project.name.lower()
+    icons = glob.glob(f"{os.path.dirname(os.path.realpath(__file__))}/../projects/icons/{prefix}.*")
+    if len(icons) == 0:
+        raise Exception(f"No icon found for {project.name}")
+    if len(icons) > 1:
+        raise Exception(f"Multiple icon formats found for {project.name}")
+    format = icons[0].split(".")[-1]
+    return prefix + '.' + format

models/render_method.py

@@ -1,10 +1,13 @@
+import glob
+import os
 from decimal import Decimal
 
 import pandas as pd
 import time
 from datetime import datetime
 
-from models.results import CalculationResults
+from models.icons import get_icon_name
+from models.results import CalculationResults, ProjectStat
 import json
 import pathlib
 import git
@@ -15,19 +18,32 @@
 Method to render results
 """
 class RenderMethod:
+    def __init__(self, icons_base_path):
+        self.icons_base_path = icons_base_path
+
     def render(self, res: CalculationResults, config: SeasonConfig):
         raise NotImplemented()
 
     def get_commit_hash(self):
         repo = git.Repo(search_parent_directories=True, path=pathlib.Path(__file__).parent.resolve())
         return  repo.head.object.hexsha
 
-    def get_items(self, res: CalculationResults):
+    def get_icon(self, project: ProjectStat, config: SeasonConfig):
+        icon_name = get_icon_name(config, project)
+        if self.icons_base_path:
+            return self.icons_base_path + icon_name
+        else:
+            return icon_name
+
+
+
+    def get_items(self, res: CalculationResults, config: SeasonConfig):
         items = []
         for item in res.ranking:
             obj = {
                 'name': item.name,
-                'score': item.score
+                'score': item.score,
+                'icon': self.get_icon(item, config)
             }
             for k, v in item.metrics.items():
                 obj[k] = float(v) if type(v) == Decimal else v
@@ -36,11 +52,13 @@ def get_items(self, res: CalculationResults):
 
 
 class JsonRenderMethod(RenderMethod):
-    def __init__(self, output_name):
+
+    def __init__(self, output_name, icons_base_path=None):
+        RenderMethod.__init__(self, icons_base_path)
         self.output_name = output_name
 
     def render(self, res: CalculationResults, config: SeasonConfig):
-        items = self.get_items(res)
+        items = self.get_items(res, config)
         res = {
             'update_time': res.build_time,
             'build_time': int(time.time()),
@@ -52,11 +70,12 @@ def render(self, res: CalculationResults, config: SeasonConfig):
             json.dump(res, out, indent=True)
 
 class HTMLRenderMethod(RenderMethod):
-    def __init__(self, output_name):
+    def __init__(self, output_name, icons_base_path=None):
+        RenderMethod.__init__(self, icons_base_path)
         self.output_name = output_name
 
     def render(self, res: CalculationResults, config: SeasonConfig):
-        items = self.get_items(res)
+        items = self.get_items(res, config)
         table = pd.DataFrame(items).to_html()
         with open(self.output_name, "wt") as out:
             out.write(f"<html><head>Results for {config.name}</head><body>")