dvcurator.readme¶
Module Contents¶
Functions¶
|
Remove all HTML tags from text |
|
Generate README.txt file. |
- dvcurator.readme.clean_html_tags(text)¶
Remove all HTML tags from text
- Parameters:
text (String) – Text to remove tags from
- Returns:
Text without HTML tags
- Return type:
String
- dvcurator.readme.generate_readme(metadata, folder, token=None)¶
Generate README.txt file.
This function uses the template assets/README.txt
- Parameters:
metadata (list) – Project metadata from get_metadata()
folder (String) – Path to QDR Prepared folder for project
token (string) – Dataverse token (required if the project is unpublished)
- Returns:
Path to newly generated README file
- Return type:
string