hub-lite/create_static_html_files.py at main · napari/hub-lite · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
from __future__ import annotations

import dataclasses
import json
import logging
import os
import re
import sys
from string import Template

from markdown_it import MarkdownIt
from markdown_it.common.utils import escapeHtml
from pygments import highlight
from pygments.formatters import HtmlFormatter
from pygments.lexers import (
    PythonLexer,
    get_lexer_by_name,
)


@dataclasses.dataclass
class PluginPageData:
    """Data needed for the plugin html page"""

    normalized_name: str
    name: str
    display_name: str
    version: str
    created_at: str | None
    modified_at: str | None
    authors: list[str]
    author_emails: list[str]
    license: str
    home_pypi: str
    home_github: str | None
    home_other: str | None
    summary: str
    categories: list[str]
    package_metadata_requires_python: str | None
    package_metadata_requires_dist: list[str]
    package_metadata_description: str
    package_metadata_classifiers: list[str]
    contributions_readers_filename_patterns: list[str]
    contributions_writers_filename_extensions: list[str]
    contributions_widgets: list[str]
    contributions_sample_data: list[str]


FALLBACK_LEXER = PythonLexer()
MISSING_LEXERS = [
    "",
    "angular2",
    "bitex",
    "bibtex",
    "commandline",
    "math",
    "mermaid",
    "{important}",
    "{note}",
    "{warning}",
]

# Configure logging
logging.basicConfig(
    level=logging.WARNING, format="%(asctime)s - %(levelname)s - %(message)s"
)
logger = logging.getLogger(__name__)


def _highlight_code(code, lang_name, lang_attrs):
    """Highlight a block of code using Pygments.
    This is the signature markdown-it uses to call the highlight function.
    Args:
        code (str): The code to highlight.
        lang_name (str): The language of the code.
        lang_attrs (dict): Additional attributes for the code block.
            (ignored here because I don't know how to use them)
    """
    try:
        if lang_name in MISSING_LEXERS:
            # Use fallback lexer
            return highlight(code, FALLBACK_LEXER, HtmlFormatter())
        else:
            lexer = get_lexer_by_name(lang_name)
    except Exception as e:
        # Captures the case that someone introduces a lexer name
        # not available in Pygments or in our list of missing lexers
        logger.error(f"Unknown error. Using fallback lexer: {e}")
        lexer = FALLBACK_LEXER

    formatter = HtmlFormatter()
    return highlight(code, lexer, formatter)


def _code_block_plugin(md):
    """Plugin to render code blocks (with indentation) the same as fenced code blocks.
    So we can use the same highlight function for both.
    """

    def _render_code_block(tokens, idx, options, env):
        """Render a code block with indentation.

        This function was mostly just copied from the default code block renderer.
        https://github.com/executablebooks/markdown-it-py
            /blob/36a9d146af52265420de634cc2e25d1d40cfcdb7/markdown_it/renderer.py#L224
        """
        token = tokens[idx]

        return (
            "<pre"
            + md.renderer.renderAttrs(token)
            + "><code>"
            + _highlight_code(escapeHtml(token.content), "", {})
            + "</code></pre>\n"
        )

    md.renderer.rules["code_block"] = _render_code_block


md = MarkdownIt("gfm-like", {"highlight": _highlight_code}).use(_code_block_plugin)


def create_plugins_list_html(plugins: list[PluginPageData], build_dir: str):
    html_content = "<html>\n<body>\n"
    for index, plugin in enumerate(plugins):
        display_name = plugin.display_name
        name = plugin.name
        normalized_name = plugin.normalized_name
        summary = plugin.summary
        authors = plugin.authors
        release_date = plugin.created_at or "Unknown"
        last_updated = plugin.modified_at or "Unknown"
        plugin_type = ", ".join(get_plugin_types(plugin)) or "Unknown"

        html_content += f'<a class="col-span-2 screen-1425:col-span-3 searchResult py-sds-xl border-black border-t-2 last:border-b-2 hover:bg-hub-gray-100" data-testid="pluginSearchResult" href="./plugins/{normalized_name}.html" data-plugin-id="{index}">\n'
        html_content += '    <article class="grid gap-x-sds-xl screen-495:gap-x-12 screen-600:grid-cols-2 screen-1425:grid-cols-napari-3" data-testid="searchResult">\n'
        html_content += '        <div class="col-span-2 screen-495:col-span-1 screen-1425:col-span-2 flex flex-col justify-between">\n'
        html_content += f'            <div>\n                <h3 class="font-bold text-lg" data-testid="searchResultDisplayName">{display_name}</h3>\n'
        html_content += f'                <span class="mt-sds-m screen-495:mt-3 text-[0.6875rem]" data-testid="searchResultName">{name}</span>\n'
        html_content += f'                <p class="mt-3" data-testid="searchResultSummary">{summary}</p>\n            </div>\n'
        html_content += '            <ul class="mt-3 text-xs">\n'
        for author in authors:
            html_content += f'                <li class="my-sds-s font-bold PluginSearchResult_linkItem__Vvs7H" data-testid="searchResultAuthor">{author}</li>\n'
        html_content += "            </ul>\n        </div>\n"
        html_content += '        <ul class="mt-sds-l screen-600:m-0 space-y-1 text-sm col-span-2 screen-495:col-span-1">\n'
        html_content += f'            <li class="grid grid-cols-[auto,1fr]" data-label="First released" data-testid="searchResultMetadata" data-value="{release_date}">\n'
        html_content += f'                <h4 class="inline whitespace-nowrap">First released<!-- -->: </h4>\n                <span class="ml-sds-xxs font-bold">{release_date}</span>\n            </li>\n'
        html_content += f'            <li class="grid grid-cols-[auto,1fr]" data-label="Last updated" data-testid="searchResultMetadata" data-value="{last_updated}">\n'
        html_content += f'                <h4 class="inline whitespace-nowrap">Last updated<!-- -->: </h4>\n                <span class="ml-sds-xxs font-bold">{last_updated}</span>\n            </li>\n'
        html_content += f'            <li class="grid grid-cols-[auto,1fr]" data-label="Plugin type" data-testid="searchResultMetadata" data-value="{plugin_type}">\n'
        html_content += f'                <h4 class="inline whitespace-nowrap">Plugin type<!-- -->: </h4><span class="ml-sds-xxs font-bold">{plugin_type}</span>\n            </li>\n        </ul>\n'
        html_content += '        <div class="mt-sds-xl text-xs flex flex-col gap-sds-s col-span-2 screen-1425:col-span-3">\n        </div>\n    </article>\n</a>\n'

    html_content += "</body>\n</html>"

    with open(f"{build_dir}/plugins_list.html", "w") as file:
        file.write(html_content)


def get_plugin_types(plugin: PluginPageData):
    return [
        ptype
        for condition, ptype in [
            (plugin.contributions_readers_filename_patterns, "reader"),
            (plugin.contributions_writers_filename_extensions, "writer"),
            (plugin.contributions_widgets, "widget"),
            (plugin.contributions_sample_data, "sample_data"),
        ]
        if condition
    ]


def generate_plugin_types_html(plugin: PluginPageData):
    plugin_types_html = ""

    plugin_types = get_plugin_types(plugin)

    if plugin_types:
        plugin_types_html = '<ul class="MetadataList_list__3DlqI list-none text-sm leading-normal inline space-y-sds-s MetadataList_inline__jHQLo">'
        for pt in plugin_types:
            plugin_types_html += f'<li class="MetadataList_textItem__KKmMN"><a class="MetadataList_textItem__KKmMN underline" href="../index.html?pluginType={pt}">{pt.capitalize()}</a></li>'
        plugin_types_html += "</ul>"

    return plugin_types_html


def generate_open_extensions_html(plugin: PluginPageData):
    open_extensions_html = ""

    filename_patterns = plugin.contributions_readers_filename_patterns
    if filename_patterns:
        open_extensions_html = '<ul class="MetadataList_list__3DlqI list-none text-sm leading-normal inline space-y-sds-s MetadataList_inline__jHQLo">'
        for pattern in filename_patterns:
            open_extensions_html += f'<li class="MetadataList_textItem__KKmMN"><a class="MetadataList_textItem__KKmMN underline" href="../index.html?readerFileExtensions={pattern}">{pattern}</a></li>'
        open_extensions_html += "</ul>"

    return open_extensions_html


def generate_save_extensions_html(plugin: PluginPageData):
    save_extensions_html = ""

    # Gather file extensions from both columns
    file_extensions = plugin.contributions_writers_filename_extensions
    if file_extensions:
        save_extensions_html = '<ul class="MetadataList_list__3DlqI list-none text-sm leading-normal inline space-y-sds-s MetadataList_inline__jHQLo">'
        for ext in file_extensions:
            save_extensions_html += f'<li class="MetadataList_textItem__KKmMN"><a class="MetadataList_textItem__KKmMN underline" href="../index.html?writerFileExtensions={ext}">{ext}</a></li>'
        save_extensions_html += "</ul>"

    return save_extensions_html


def generate_requirements_html(plugin: PluginPageData):
    requirements_html = ""

    requirements = plugin.package_metadata_requires_dist
    if requirements:
        requirements_html = (
            '<ul class="MetadataList_list__3DlqI list-none text-sm leading-normal">'
        )
        for req in requirements:
            requirements_html += f'<li class="MetadataList_textItem__KKmMN">{req}</li>'
        requirements_html += "</ul>"

    return requirements_html


def parse_version_specifier(specifier, default_min_version="3.6"):
    # Parse version specifiers to get the min and max version
    min_version = default_min_version
    max_version = None
    specifiers = specifier.split(",")

    for spec in specifiers:
        if ">=" in spec:
            min_version = spec.split(">=")[1]
        elif "<=" in spec:
            max_version = spec.split("<=")[1]
        elif "<" in spec:
            # If strictly less than, consider the next lower minor version as the max
            max_version = str(float(spec.split("<")[1]) - 0.1)

    return min_version, max_version


def generate_python_versions_html(
    plugin: PluginPageData,
    max_supported_version="3.11",
    default_min_version="3.6",
):
    requirement = plugin.package_metadata_requires_python or ""
    min_version, max_version = parse_version_specifier(requirement)

    # Use the given maximum version if no upper bound is specified
    max_version = max_version if max_version else max_supported_version
    min_minor = (
        int(min_version.split(".")[1])
        if min_version
        else int(default_min_version.split(".")[1])
    )
    max_minor = int(max_version.split(".")[1])

    # Generate a list of versions from min_version to max_version
    versions = [f"3.{v}" for v in range(min_minor, max_minor + 1)]

    # Construct HTML list items for each version
    python_versions_html = '<ul class="MetadataList_list__3DlqI list-none text-sm leading-normal inline space-y-sds-s MetadataList_inline__jHQLo">'
    for version in versions:
        python_versions_html += f'<li class="MetadataList_textItem__KKmMN"><a class="MetadataList_textItem__KKmMN underline" href="../index.html?python={version}">{version}</a></li>'
    python_versions_html += "</ul>"

    return python_versions_html


def generate_os_html(plugin: PluginPageData):
    package_metadata_classifiers = plugin.package_metadata_classifiers
    # Default message if no operating system info is found
    default_os_html = (
        '<ul class="MetadataList_list__3DlqI list-none text-sm leading-normal">'
        '<li class="flex justify-between items-center"><span '
        'class="text-napari-gray font-normal lowercase">Information not '
        "submitted</span></li>"
        "</ul>"
    )

    # Compose html from classifier or use the default
    os_html = default_os_html
    for item in package_metadata_classifiers:
        if "Operating System ::" in item:
            os = item.split("Operating System :: ")[1].strip("' \"")
            os_html = (
                '<ul class="MetadataList_list__3DlqI list-none text-sm leading-normal">'
                f'<li class="MetadataList_textItem__KKmMN">{os}</li>'
                "</ul>"
            )
            break
    return os_html


def extract_github_info(url):
    match = re.search(r"github\.com/(?P<user>[^/]+)/(?P<repo>[^/]+)(?:\.git)?", url)
    user = match.group("user") if match else None
    repo = match.group("repo") if match else None
    return user, repo


def generate_home_html(plugin: PluginPageData):
    plugin_name = plugin.name
    home_pypi = plugin.home_pypi
    home_github = plugin.home_github
    home_other = plugin.home_other

    # Start with the PyPI link, which is always present
    html_content = f'''
   <div class="flex items-center" style="gap: 20px; ; align-items: center;"">
        <a class="underline flex" href="{home_pypi}" rel="noreferrer" target="_blank">
        <img src="../static/images/PyPI_logo.svg.png" alt="PyPI" style="height: 42px;" /><span style="padding-top: 10px; padding-left: 10px;">{plugin_name}</span>
    </a>
    '''

    # Conditionally add the GitHub link
    if home_github and str(home_github).lower() not in ["n/a", "none", "nan", ""]:
        github_user_repo = ""
        user, repo = extract_github_info(home_github)
        if user is not None and repo is not None:
            github_user_repo = "/".join([user, repo])
        html_content += f'''
        <a class="underline flex" href="{home_github}" rel="noreferrer" target="_blank">
            <img src="../static/images/GitHub_Invertocat_Logo.svg.png" alt="GitHub" style="height: 42px;" /><span style="padding-top: 10px; padding-left: 10px;">{github_user_repo}</span>
        </a>
        '''

    # Conditionally add the Other link
    if home_other and str(home_other).lower() not in ["n/a", "none", "nan", ""]:
        html_content += f'''
        <a href="{home_other}" rel="noreferrer" target="_blank">
        <svg width="21" height="21" viewBox="0 0 21 21" fill="none" xmlns="http://www.w3.org/2000/svg">
            <circle cx="10.8331" cy="10.0835" r="9.33333" stroke="#000" stroke-width="1.33333"></circle>
            <path
                d="M15.4998 10.0835C15.4998 12.7576 14.9202 15.1456 14.0161 16.8408C13.0967 18.5648 11.9398 19.4168 10.8331 19.4168C9.7264 19.4168 8.56951 18.5648 7.65009 16.8408C6.74594 15.1456 6.16642 12.7576 6.16642 10.0835C6.16642 7.40935 6.74594 5.02142 7.65009 3.32615C8.56951 1.60224 9.7264 0.750163 10.8331 0.750163C11.9398 0.750163 13.0967 1.60224 14.0161 3.32615C14.9202 5.02142 15.4998 7.40935 15.4998 10.0835Z"
                stroke="#000" stroke-width="1.33333"></path>
            <path d="M10.8331 0.270996V19.896" stroke="#000" stroke-width="1.33333"></path>
            <path d="M1.02063 10.0835L20.6456 10.0835" stroke="#000" stroke-width="1.33333"></path>
        </svg>
        </a>
        '''

    # Close the div tag
    html_content += "</div>"

    return html_content


def create_plugin_page_html(plugin: PluginPageData, template, plugin_dir):
    # package_metadata_description is the README content (we assume markdown)
    if plugin.package_metadata_description:
        # remove the first line if it's a markdown header
        lines = plugin.package_metadata_description.split("\n")
        if lines and lines[0].startswith("#"):
            no_first_header = "\n".join(lines[1:])
        else:
            no_first_header = "\n".join(lines)
        html_description = md.render(no_first_header)
    else:
        html_description = "No description available"

    plugin_types_html = generate_plugin_types_html(plugin)
    openfile_types_html = generate_open_extensions_html(plugin)
    savefile_types_html = generate_save_extensions_html(plugin)
    requirements_html = generate_requirements_html(plugin)
    python_versions_html = generate_python_versions_html(plugin)
    os_html = generate_os_html(plugin)
    home_html = generate_home_html(plugin)

    template_data = dataclasses.asdict(plugin)
    template_data["authors"] = ", ".join(plugin.authors)
    template_data["open_extension"] = openfile_types_html
    template_data["save_extension"] = savefile_types_html
    template_data["plugin_types"] = plugin_types_html
    template_data["requirements"] = requirements_html
    template_data["python_versions"] = python_versions_html
    template_data["os"] = os_html
    template_data["package_metadata_description"] = html_description
    template_data["home_link"] = home_html

    # Create a new Template with the row data
    filled_template = Template(template).safe_substitute(template_data)

    # Save the HTML file for each plugin
    os.makedirs(plugin_dir, exist_ok=True)
    with open(f"{plugin_dir}/{plugin.normalized_name}.html", "w") as file:
        file.write(filled_template)


if __name__ == "__main__":
    build_dir = sys.argv[1] if len(sys.argv) > 1 else "."
    data_dir = f"{build_dir}/data"
    static_dir = f"{build_dir}/static"
    plugin_dir = f"{build_dir}/plugins"
    template_dir = f"{build_dir}/templates"

    with open(f"{data_dir}/plugin_page_data.json") as file:
        plugins_data = [PluginPageData(**plugin) for plugin in json.load(file)]

    create_plugins_list_html(plugins_data, build_dir)

    # Read the individual plugin HTML template
    with open(f"{template_dir}/each_plugin_template.html") as file:
        template = file.read()

    # Generate individual plugin pages
    for plugin in plugins_data:
        create_plugin_page_html(plugin, template, plugin_dir)