add creating the badge link from the weekly workflow

Author: 1ucian0

.github/workflows/weekly-badge-and-stats-update.yml

@@ -25,7 +25,11 @@ jobs:
         pip install -r requirements.txt
 
     - name: Update badges
-      run: python manager.py members update_badges
+      env:
+        BITLY_TOKEN: ${{ secrets.BITLY_TOKEN }}
+      run: |
+        python manager.py members update_badges
+        python manager.py members update_badge_list
 
     - name: Update stats
       run: python manager.py members update_github

ecosystem/cli/members.py

@@ -94,6 +94,49 @@ def update_badges(self):
             ) as outfile:
                 json.dump(data, outfile, indent=4)
                 self.logger.info("Badge for %s has been updated.", project.name)
+            project.update_badge()
+            self.dao.update(project.name_id, badge=project.badge)
+
+    def update_badge_list(self):
+        """Updates badge list in qisk.it/ecosystem-badges."""
+        start_tag = "<!-- start:table-badge -->"
+        end_tag = "<!-- end:table-badge -->"
+
+        projects = []
+        for project in self.dao.get_all():
+            if project.badge is None:
+                continue
+            projects.append((project.name, project.badge, project.badge_md))
+
+        projects.sort(key=lambda x: x[0].casefold())
+
+        lines = [
+            "",
+            "<table>",
+            '<tr><th width="10%">Member</th><th width="60%">Badge</th><th>MD Code</th></tr>',
+        ]
+        for name, badge, badge_md in projects:
+            lines.append(
+                "<tr>"
+                f"<td>{name}</td>"
+                f'<td><img src="{badge}" /></td>'
+                f'<td><pre class="notranslate"><code>{badge_md}</code> &nbsp; </pre></td>'
+                "</tr>"
+            )
+        lines.append("</table>\n")
+        readme_md = os.path.join(self.current_dir, "badges", "README.md")
+
+        with open(readme_md, "r") as readme_file:
+            content = readme_file.read()
+
+        to_replace = content[
+            content.find(start_tag) + len(start_tag) : content.rfind(end_tag)
+        ]
+
+        new_content = content.replace(to_replace, "\n".join(lines))
+
+        with open(readme_md, "w") as outfile:
+            outfile.write(new_content)
 
     def update_github(self):
         """Updates GitHub data."""

ecosystem/member.py

@@ -7,7 +7,7 @@
 from .serializable import JsonSerializable, parse_datetime
 from .github import GitHubData
 from .pypi import PyPIData
-from .request import URL
+from .request import URL, request_json
 
 
 class Member(JsonSerializable):  # pylint: disable=too-many-instance-attributes
@@ -32,6 +32,7 @@ def __init__(  # pylint: disable=too-many-arguments, too-many-locals
         documentation: URL | None = None,
         packages: list[URL] | None = None,
         uuid: str | None = None,
+        badge: str | None = None,
         github: GitHubData | None = None,
         pypi: dict[str, PyPIData] | None = None,
         julia: JuliaData | None = None,
@@ -56,6 +57,7 @@ def __init__(  # pylint: disable=too-many-arguments, too-many-locals
         self.github = github
         self.pypi = pypi
         self.julia = julia
+        self.badge = badge
 
         self.__dict__.setdefault("created_at", parse_datetime("now"))
         self.__dict__.setdefault("updated_at", parse_datetime("now"))
@@ -100,7 +102,6 @@ def to_dict(self) -> dict:
         base_dict = super().to_dict()
         if "ibm_maintained" in base_dict and base_dict["ibm_maintained"] is False:
             del base_dict["ibm_maintained"]
-        base_dict["badge"] = self.badge
         return base_dict
 
     def __eq__(self, other: "Member"):
@@ -127,12 +128,12 @@ def name_id(self):
         return repo_dir.lower().replace(".", "_")
 
     @property
-    def badge(self):
+    def badge_md(self):
         """Markdown with the badge for README"""
         return (
-            "[![Qiskit Ecosystem](https://img.shields.io/endpoint?"
-            "style=flat&url=https%3A%2F%2Fqiskit.github.io%2Fecosystem%"
-            f"2Fb%2F{self.short_uuid})](https://qisk.it/e)"
+            f"[![Qiskit Ecosystem]({self.badge})](https://qisk.it/e)"
+            if self.badge
+            else None
         )
 
     def update_github(self):
@@ -142,6 +143,24 @@ def update_github(self):
         self.github.update_json()
         self.github.update_owner_repo()
 
+    def _create_qisk_dot_it_link_for_badge(self):
+        data = {
+            "long_url": "https://img.shields.io/endpoint?style=flat&url="
+            f"https://qiskit.github.io/ecosystem/b/{self.short_uuid}",
+            "domain": "qisk.it",
+            "keyword": f"e-{self.short_uuid}",
+            "group_guid": "Bj9rgMHKfxH",
+            "title": f'Qiskit ecosystem "{self.name}" badge',
+            "tags": ["qiskit ecosystem badge", "permanent _do NOT remove_"],
+        }
+        response = request_json("https://api-ssl.bitly.com/v4/bitlinks", post=data)
+        return response["link"]
+
+    def update_badge(self):
+        """If not there yet, creates a new Bitly link for the badge"""
+        if self.badge is None:
+            self.badge = self._create_qisk_dot_it_link_for_badge()
+
     def update_pypi(self):
         """
         Updates all the PyPI information in the project.

ecosystem/request.py

@@ -20,9 +20,16 @@
 
 
 def request_json(
-    url: str, headers: dict[str, str] = None, parser=None, content_handler=None
+    url: str,
+    headers: dict[str, str] = None,
+    post=None,
+    parser=None,
+    content_handler=None,
 ):
-    """Requests the JSON in <url> with <headers>"""
+    """Requests the JSON in <url> with <headers>
+
+    if post is set with a dictionary, then that dict is sent as POST's JSON
+    """
     if parser is None:
         parser = json.loads
     url = URL(url)
@@ -41,7 +48,16 @@ def request_json(
             headers["Authorization"] = "token " + token
         headers["User-Agent"] = "github.com/Qiskit/ecosystem/"
 
-    response = requests.get(str(url), headers=headers, timeout=240)
+    if url.hostname.endswith("bitly.com"):
+        token = os.getenv("BITLY_TOKEN")
+        if token:
+            headers["Authorization"] = "Bearer " + token
+
+    if post is None:
+        response = requests.get(str(url), headers=headers, timeout=240)
+    else:
+        response = requests.post(str(url), headers=headers, timeout=240, json=post)
+
     if not response.ok:
         raise EcosystemError(
             f"Bad response {str(url)}: {response.reason} ({response.status_code})"