|
| 1 | +import argparse |
| 2 | +import json |
| 3 | +import shutil |
| 4 | +from collections import defaultdict |
| 5 | +from pathlib import Path |
| 6 | + |
| 7 | + |
| 8 | +def output_markdown(processed, output_base_path): |
| 9 | + packages = sum(len(v) for v in processed.values()) |
| 10 | + top_page = open(output_base_path / 'index.md', 'w') |
| 11 | + top_page.write("# List of supported software\n\n") |
| 12 | + top_page.write(f"EasyBuild supports {packages} different software packages (incl. toolchains, bundles):\n\n") |
| 13 | + |
| 14 | + for letter in processed: |
| 15 | + top_page.write(f" * [{letter}]({letter}/index.md)\n") |
| 16 | + |
| 17 | + letter_dir = output_base_path / letter |
| 18 | + letter_dir.mkdir() |
| 19 | + letter_page = open(letter_dir / 'index.md', 'w') |
| 20 | + letter_page.write(f"# List of supported software ({letter})\n\n") |
| 21 | + |
| 22 | + for software in processed[letter]: |
| 23 | + top_page.write(f" * [{software}]({letter}/{software}.md)\n") |
| 24 | + letter_page.write(f" * [{software}]({software}.md)\n") |
| 25 | + |
| 26 | + versionsuffix = any(v['versionsuffix'] for v in processed[letter][software]) |
| 27 | + |
| 28 | + software_page = open(letter_dir / f'{software}.md', 'w') |
| 29 | + software_page.write(f"# {software}\n\n") |
| 30 | + software_page.write(f"{processed[letter][software][0]['description']}\n\n") |
| 31 | + software_page.write(f"*homepage*: <{processed[letter][software][0]['homepage']}>\n\n") |
| 32 | + |
| 33 | + if versionsuffix: |
| 34 | + software_page.write("version | versionsuffix | toolchain\n") |
| 35 | + software_page.write("--------|---------------|----------\n") |
| 36 | + else: |
| 37 | + software_page.write("version | toolchain\n") |
| 38 | + software_page.write("--------|----------\n") |
| 39 | + |
| 40 | + for version in processed[letter][software]: |
| 41 | + software_page.write(f"``{version['version']}`` | ") |
| 42 | + if versionsuffix: |
| 43 | + if version['versionsuffix']: |
| 44 | + software_page.write(f"``{version['versionsuffix']}``") |
| 45 | + software_page.write(" | ") |
| 46 | + software_page.write(f"``{version['toolchain']}``\n") |
| 47 | + |
| 48 | + software_page.close() |
| 49 | + |
| 50 | + letter_page.close() |
| 51 | + |
| 52 | + top_page.close() |
| 53 | + |
| 54 | + |
| 55 | +def generate_markdown_pages(jsonfile, output_base, delete_existing): |
| 56 | + """ |
| 57 | + Generate markdown |
| 58 | + :param jsonfile: input file (json file) |
| 59 | + :param output_base: base directory for output files |
| 60 | + :param delete_existing: delete the output directory (if it exists) |
| 61 | + """ |
| 62 | + with open(jsonfile) as f: |
| 63 | + data = json.load(f) |
| 64 | + |
| 65 | + processed = defaultdict(lambda: defaultdict(list)) |
| 66 | + for software in data: |
| 67 | + initial = software['name'][0].lower() |
| 68 | + if initial.isnumeric(): |
| 69 | + initial = '0' |
| 70 | + processed[initial][software['name']].append(software) |
| 71 | + |
| 72 | + output_base_path = Path(output_base) |
| 73 | + |
| 74 | + if delete_existing and output_base_path.exists() and output_base_path.is_dir(): |
| 75 | + shutil.rmtree(output_base_path) |
| 76 | + |
| 77 | + output_base_path.mkdir(parents=True) |
| 78 | + output_markdown(processed, output_base_path) |
| 79 | + |
| 80 | + |
| 81 | +if __name__ == "__main__": |
| 82 | + parser = argparse.ArgumentParser(prog='Software Markdown Pages', |
| 83 | + description='Generate Markdown pages of software from JSON file') |
| 84 | + parser.add_argument('-j', '--jsonfile', default='software.json', help='Input JSON file') |
| 85 | + parser.add_argument('-o', '--output-base', default='output', help='Base directory for output files') |
| 86 | + parser.add_argument('--delete-existing-output', action='store_true', |
| 87 | + help='Delete output base directory (if it exists)') |
| 88 | + args = parser.parse_args() |
| 89 | + |
| 90 | + generate_markdown_pages(args.jsonfile, args.output_base, args.delete_existing_output) |
0 commit comments