hosting/ynh-apps_tools
1
0
Fork 0
Code Activity

Factorize README generation into a function

Browse source
This commit is contained in:
Alexandre Aubin 2021-04-28 20:14:48 +02:00
parent b2d19fd022
commit f6d0b63166
1 changed files with 33 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
READMEs/make_readme.py
View file

@ -4,40 +4,45 @@ import os
from jinja2 import Environment, FileSystemLoader from jinja2 import Environment, FileSystemLoader
parser = argparse.ArgumentParser(description='Automatically (re)generate README for apps')
parser.add_argument('app_path',
help='Path to the app to generate/update READMEs for')
args = parser.parse_args() def generate_READMEs(app_path):
app_path = args.app_path
if not os.path.exists(app_path): if not os.path.exists(app_path):
raise Exception("App path provided doesn't exists ?!") raise Exception("App path provided doesn't exists ?!")
env = Environment(loader=FileSystemLoader('./templates')) env = Environment(loader=FileSystemLoader('./templates'))
for lang, lang_suffix in [("en", ""), ("fr", "_fr")]: for lang, lang_suffix in [("en", ""), ("fr", "_fr")]:
template = env.get_template(f'README{lang_suffix}.md.j2') template = env.get_template(f'README{lang_suffix}.md.j2')
manifest = json.load(open(os.path.join(app_path, "manifest.json"))) manifest = json.load(open(os.path.join(app_path, "manifest.json")))
upstream = manifest.get("upstream", {}) upstream = manifest.get("upstream", {})
if os.path.exists(os.path.join(app_path, "doc", "screenshots")): if os.path.exists(os.path.join(app_path, "doc", "screenshots")):
screenshots = os.listdir(os.path.join(app_path, "doc", "screenshots")) screenshots = os.listdir(os.path.join(app_path, "doc", "screenshots"))
if ".gitkeep" in screenshots: if ".gitkeep" in screenshots:
screenshots.remove(".gitkeep") screenshots.remove(".gitkeep")
else: else:
screenshots = [] screenshots = []
if os.path.exists(os.path.join(app_path, "doc", f"DISCLAIMER{lang_suffix}.md")): if os.path.exists(os.path.join(app_path, "doc", f"DISCLAIMER{lang_suffix}.md")):
disclaimer = open(os.path.join(app_path, "doc", f"DISCLAIMER{lang_suffix}.md")).read() disclaimer = open(os.path.join(app_path, "doc", f"DISCLAIMER{lang_suffix}.md")).read()
# Fallback to english if maintainer too lazy to translate the disclaimer idk # Fallback to english if maintainer too lazy to translate the disclaimer idk
elif os.path.exists(os.path.join(app_path, "doc", "DISCLAIMER.md")): elif os.path.exists(os.path.join(app_path, "doc", "DISCLAIMER.md")):
disclaimer = open(os.path.join(app_path, "doc", "DISCLAIMER.md")).read() disclaimer = open(os.path.join(app_path, "doc", "DISCLAIMER.md")).read()
else: else:
disclaimer = None disclaimer = None
out = template.render(lang=lang, upstream=upstream, screenshots=screenshots, disclaimer=disclaimer, manifest=manifest) out = template.render(lang=lang, upstream=upstream, screenshots=screenshots, disclaimer=disclaimer, manifest=manifest)
with open(os.path.join(app_path, f"README{lang_suffix}.md"), "w") as f: with open(os.path.join(app_path, f"README{lang_suffix}.md"), "w") as f:
f.write(out) f.write(out)
if __name__ == "__main__":
parser = argparse.ArgumentParser(description='Automatically (re)generate README for apps')
parser.add_argument('app_path',
help='Path to the app to generate/update READMEs for')
args = parser.parse_args()
generate_READMEs(args.app_path)