🔀 Merge pull request #71 from pabnas/general_fix_and_update_styles

General fix and update styles

Author: astariul

.github/__init__.py

@@ -1,5 +1,4 @@
 import os
-import json
 import copy
 import re
 import shutil
@@ -11,12 +10,35 @@
 TEMPLATE_FILE = "pkg_template.html"
 YAML_ACTION_FILES = [".github/workflows/delete.yml", ".github/workflows/update.yml"]
 
+INDEX_CARD_HTML = '''
+<a class="card" href="">
+    placeholder_name
+    <span>
+    </span>
+    <span class="version">
+        placehholder_version
+    </span>
+    <br/>
+    <span class="description">
+        placeholder_description
+    </span>
+</a>'''
+
 
 def normalize(name):
     """ From PEP503 : https://www.python.org/dev/peps/pep-0503/ """
     return re.sub(r"[-_.]+", "-", name).lower()
 
 
+def normalize_version(version):
+    version = version.lower()
+    return version[1:] if version.startswith("v") else version
+
+
+def is_stable(version):
+    return not ("dev" in version or "a" in version or "b" in version or "rc" in version)
+
+
 def package_exists(soup, package_name):
     package_ref = package_name + "/"
     for anchor in soup.find_all('a'):
@@ -25,26 +47,40 @@ def package_exists(soup, package_name):
     return False
 
 
-def register(pkg_name, version, author, short_desc, long_desc, homepage, link):
+def transform_github_url(input_url):
+    # Split the input URL to extract relevant information
+    parts = input_url.rstrip('/').split('/')
+    username, repo = parts[-2], parts[-1]
+
+    # Create the raw GitHub content URL
+    raw_url = f'https://raw.githubusercontent.com/{username}/{repo}/main/README.md'
+    return raw_url
+
+
+def register(pkg_name, version, author, short_desc, homepage):
+    link = f'git+{homepage}@{version}'
+    long_desc = transform_github_url(homepage)
     # Read our index first
     with open(INDEX_FILE) as html_file:
         soup = BeautifulSoup(html_file, "html.parser")
     norm_pkg_name = normalize(pkg_name)
+    norm_version = normalize_version(version)
 
     if package_exists(soup, norm_pkg_name):
-        raise ValueError("Package {} seems to already exists".format(norm_pkg_name))
+        raise ValueError(f"Package {norm_pkg_name} seems to already exists")
 
     # Create a new anchor element for our new package
-    last_anchor = soup.find_all('a')[-1]        # Copy the last anchor element
-    new_anchor = copy.copy(last_anchor)
-    new_anchor['href'] = "{}/".format(norm_pkg_name)
-    new_anchor.contents[0].replace_with(pkg_name)
-    spans = new_anchor.find_all('span')
-    spans[1].string = version       # First span contain the version
+    placeholder_card = BeautifulSoup(INDEX_CARD_HTML, 'html.parser')
+    placeholder_card = placeholder_card.find('a')
+    new_package = copy.copy(placeholder_card)
+    new_package['href'] = f"{norm_pkg_name}/"
+    new_package.contents[0].replace_with(pkg_name)
+    spans = new_package.find_all('span')
+    spans[1].string = norm_version  # First span contain the version
     spans[2].string = short_desc    # Second span contain the short description
 
     # Add it to our index and save it
-    last_anchor.insert_after(new_anchor)
+    soup.find('h6', class_='text-header').insert_after(new_package)
     with open(INDEX_FILE, 'wb') as index:
         index.write(soup.prettify("utf-8"))
 
@@ -53,49 +89,71 @@ def register(pkg_name, version, author, short_desc, long_desc, homepage, link):
         template = temp_file.read()
 
     template = template.replace("_package_name", pkg_name)
-    template = template.replace("_version", version)
-    template = template.replace("_link", "{}#egg={}-{}".format(link, norm_pkg_name, version))
+    template = template.replace("_version", norm_version)
+    template = template.replace("_link", f"{link}#egg={norm_pkg_name}-{norm_version}")
     template = template.replace("_homepage", homepage)
     template = template.replace("_author", author)
     template = template.replace("_long_description", long_desc)
+    template = template.replace("_latest_main", norm_version)
 
     os.mkdir(norm_pkg_name)
     package_index = os.path.join(norm_pkg_name, INDEX_FILE)
     with open(package_index, "w") as f:
         f.write(template)
 
 
-def update(pkg_name, version, link):
+def update(pkg_name, version):
     # Read our index first
     with open(INDEX_FILE) as html_file:
         soup = BeautifulSoup(html_file, "html.parser")
     norm_pkg_name = normalize(pkg_name)
+    norm_version = normalize_version(version)
 
     if not package_exists(soup, norm_pkg_name):
-        raise ValueError("Package {} seems to not exists".format(norm_pkg_name))
+        raise ValueError(f"Package {norm_pkg_name} seems to not exists")
 
-    # Change the version in the main page
-    anchor = soup.find('a', attrs={"href": "{}/".format(norm_pkg_name)})
-    spans = anchor.find_all('span')
-    spans[1].string = version
-    with open(INDEX_FILE, 'wb') as index:
-        index.write(soup.prettify("utf-8"))
+    # Change the version in the main page (only if stable)
+    if is_stable(version):
+        anchor = soup.find('a', attrs={"href": f"{norm_pkg_name}/"})
+        spans = anchor.find_all('span')
+        spans[1].string = norm_version
+        with open(INDEX_FILE, 'wb') as index:
+            index.write(soup.prettify("utf-8"))
 
     # Change the package page
     index_file = os.path.join(norm_pkg_name, INDEX_FILE) 
     with open(index_file) as html_file:
         soup = BeautifulSoup(html_file, "html.parser")
+        
+    # Extract the URL from the onclick attribute
+    button = soup.find('button', id='repoHomepage')
+    if button:
+        link = button.get("onclick")[len("location.href='"):-1]
+    else:
+        raise Exception("Homepage URL not found")
 
     # Create a new anchor element for our new version
-    last_anchor = soup.find_all('a')[-1]        # Copy the last anchor element
-    new_anchor = copy.copy(last_anchor)
-    new_anchor['href'] = "{}#egg={}-{}".format(link, norm_pkg_name, version)
+    original_div = soup.find('section', class_='versions').findAll('div')[-1]
+    new_div = copy.copy(original_div)
+    anchor = new_div.find('a')
+    new_div['onclick'] = f"load_readme('{version}', scroll_to_div=true);"
+    new_div['id'] = norm_version
+    new_div['class'] = ""
+    if not is_stable(version):
+        new_div['class'] += "prerelease"
+    else:
+        # replace the latest main version
+        main_version_span = soup.find('span', id='latest-main-version')
+        main_version_span.string = norm_version
+    anchor.string = norm_version
+    anchor['href'] = f"git+{link}@{version}#egg={norm_pkg_name}-{norm_version}"
 
     # Add it to our index
-    last_anchor.insert_after(new_anchor)
+    original_div.insert_after(new_div)
 
-    # Change the latest version
-    soup.html.body.div.section.find_all('span')[1].contents[0].replace_with(version) 
+    # Change the latest version (if stable)
+    if is_stable(version):
+        soup.html.body.div.section.find_all('span')[1].contents[0].replace_with(norm_version)
 
     # Save it
     with open(index_file, 'wb') as index:
@@ -109,13 +167,13 @@ def delete(pkg_name):
     norm_pkg_name = normalize(pkg_name)
 
     if not package_exists(soup, norm_pkg_name):
-        raise ValueError("Package {} seems to not exists".format(norm_pkg_name))
+        raise ValueError(f"Package {norm_pkg_name} seems to not exists")
 
     # Remove the package directory
     shutil.rmtree(norm_pkg_name)
 
     # Find and remove the anchor corresponding to our package
-    anchor = soup.find('a', attrs={"href": "{}/".format(norm_pkg_name)})
+    anchor = soup.find('a', attrs={"href": f"{norm_pkg_name}/"})
     anchor.extract()
     with open(INDEX_FILE, 'wb') as index:
         index.write(soup.prettify("utf-8"))
@@ -131,17 +189,16 @@ def main():
             version=os.environ["PKG_VERSION"],
             author=os.environ["PKG_AUTHOR"],
             short_desc=os.environ["PKG_SHORT_DESC"],
-            long_desc=os.environ["PKG_LONG_DESC"],
             homepage=os.environ["PKG_HOMEPAGE"],
-            link=os.environ["PKG_LINK"],
         )
     elif action == "DELETE":
-        delete(pkg_name=os.environ["PKG_NAME"])
+        delete(
+            pkg_name=os.environ["PKG_NAME"]
+        )
     elif action == "UPDATE":
         update(
             pkg_name=os.environ["PKG_NAME"],
-            version=os.environ["PKG_VERSION"],
-            link=os.environ["PKG_LINK"],
+            version=os.environ["PKG_VERSION"]
         )
 
 

.github/actions.py

@@ -8,29 +8,21 @@ on:
         required: true
         type: string
       version:
-        description: 'Version of the package'
+        description: 'Version of the package (tag name)'
         required: true
         type: string
       author:
         description: 'Author(s) of the package'
         required: true
         type: string
       short_desc:
-        description: 'A short description of the package'
-        required: true
-        type: string
-      long_desc:
-        description: 'A longer description of the package (HTML)'
+        description: 'A short description of the package to show on the index'
         required: true
         type: string
       homepage:
         description: 'Homepage of the package (link to the github repository)'
         required: true
         type: string
-      link:
-        description: 'Link used for `pip`. For example, for a github-hosted package refered by the tag `v3.0.2`, it would be : git+https://github.com/huggingface/transformers@v3.0.2'
-        required: true
-        type: string
 
 jobs:
   update:
@@ -52,9 +44,7 @@ jobs:
         PKG_VERSION: ${{ inputs.version }}
         PKG_AUTHOR: ${{ inputs.author }}
         PKG_SHORT_DESC: ${{ inputs.short_desc }}
-        PKG_LONG_DESC: ${{ inputs.long_desc }}
         PKG_HOMEPAGE: ${{ inputs.homepage }}
-        PKG_LINK: ${{ inputs.link }}
       run: |
         pip install beautifulsoup4
         python .github/actions.py 

.github/workflows/register.yml

@@ -8,12 +8,7 @@ on:
         required: true
         type: string
       version:
-        description: New version of the package
-        required: true
-        type: string
-      link:
-        description: 'Link used for `pip`. For example, for a github-hosted package
-          refered by the tag `v3.0.2`, it would be : git+https://github.com/huggingface/transformers@v3.0.2'
+        description: New version of the package (tag name)
         required: true
         type: string
 
@@ -35,7 +30,6 @@ jobs:
         PKG_ACTION: UPDATE
         PKG_NAME: ${{ inputs.package_name }}
         PKG_VERSION: ${{ inputs.version }}
-        PKG_LINK: ${{ inputs.link }}
       run: |
         pip install beautifulsoup4
         python .github/actions.py 

.github/workflows/update.yml

@@ -8,60 +8,16 @@
   <link crossorigin="anonymous" href="https://cdnjs.cloudflare.com/ajax/libs/skeleton/2.0.4/skeleton.min.css" rel="stylesheet"/>
   <!-- Font -->
   <link href="https://fonts.googleapis.com/css2?family=Montserrat:wght@300;400;600&amp;display=swap" rel="stylesheet" type="text/css"/>
-  <!-- JQuery -->
-  <script src="https://code.jquery.com/jquery-latest.min.js"></script>
-  <!-- Our JS -->
-  <script type="text/javascript" src="pypi_checker.js"></script>
   <!-- Favicon -->
   <link href="https://gist.githubusercontent.com/astariul/c09af596e802e945d3032774e10e1047/raw/f693a2e2b65966494da082887bc4be2917f615e4/random_icon.svg" rel="icon"/>
-  <style>
-   body { font-family: "Montserrat"; }
-		code {
-			font-size: 100%;
-            display: inline-block !important;
-            font-size: 1.3rem; }
-		.header { 
-			margin-top: 6rem;
-			text-align: center; }
-		.text-header {
-			text-transform: uppercase;
-			font-size: 1.4rem;
-			letter-spacing: .2rem;
-			font-weight: 600; }
-		.card {
-			display: inline-block;
-			height: auto;
-			min-width: 32%;
-			padding: 0.5rem 2rem;
-			margin: 0.5rem 0.5rem;
-			color: #555;
-			font-size: 1.5rem;
-			font-weight: 600;
-			line-height: 1.5;
-			letter-spacing: .05rem;
-			text-decoration: none;
-			white-space: normal;
-			background-color: transparent;
-			border-radius: 4px;
-			border: 1px solid #bbb;
-			cursor: pointer;
-			box-sizing: border-box; }
-    .card:hover {
-      border-color: darkcyan;
-      color: darkcyan; }
-		.version {
-			font-size: 1rem; 
-			font-style: italic;}
-		.description {
-			font-weight: 300; }
-    .redalert {
-      border-color: crimson;
-      color: crimson; }
-    .redalert:hover {
-      border-color: tomato;
-      color: tomato;
-    }
-  </style>
+  <!-- Custom Styles -->
+  <link href="static/index_styles.css" rel="stylesheet"/>
+  <!-- JQuery -->
+  <script src="https://code.jquery.com/jquery-latest.min.js">
+  </script>
+  <!-- Our JS -->
+  <script src="static/pypi_checker.js" type="text/javascript">
+  </script>
   <title>
    Pypi - YourCompany
   </title>
@@ -128,7 +84,7 @@ <h6 class="text-header">
     <span>
     </span>
     <span class="version">
-     3.0
+     3.0.0
     </span>
     <br/>
     <span class="description">
@@ -137,19 +93,19 @@ <h6 class="text-header">
    </a>
   </div>
   <script>
-    $(document).ready(function(){
+   $(document).ready(function(){
       for (let lnk of document.getElementsByTagName('a')) {
-        var content = lnk.textContent.trim().replace(/\s\s+/g, ' ').split(" ");
-        var pkg_name = content[0];
-        var pkg_vers = content[1];
+          var content = lnk.textContent.trim().replace(/\s\s+/g, ' ').split(" ");
+          var pkg_name = content[0];
+          var pkg_vers = content[1];
 
-        function mark_red() {
-          lnk.classList.add("redalert");
-        }
+          function mark_red() {
+              lnk.classList.add("redalert");
+          }
 
-        check_supply_chain_attack(pkg_name, pkg_vers, mark_red);
+          check_supply_chain_attack(pkg_name, pkg_vers, mark_red);
       }
-    });
+  });
   </script>
  </body>
-</html>
+</html>