genomepy.files.update_readme

genomepy.files.update_readme(readme: str, updated_metadata: dict = None, extra_lines: list = None)

Update a readme file with supplied information.

Parameters
  • readme (str) – filename

  • updated_metadata (dict) – dict with updated data

  • extra_lines (list, optional) – additional lines of text to append