dvcurator.readme
================

.. py:module:: dvcurator.readme


Functions
---------

.. autoapisummary::

   dvcurator.readme.clean_html_tags
   dvcurator.readme.generate_readme


Module Contents
---------------

.. py:function:: clean_html_tags(text)

   Remove all HTML tags from text

   :param text: Text to remove tags from
   :type text: String
   :return: Text without HTML tags
   :rtype: String



.. py:function:: generate_readme(metadata, folder, token=None, repo=None)

   Generate README.txt file. 

   This function uses the template assets/README.txt

   :param metadata: Project metadata from `get_metadata()`
   :type metadata: list
   :param folder: Path to QDR Prepared folder for project
   :type folder: String
   :param token: Dataverse token (required if the project is unpublished)
   :type token: string

   :return: Path to newly generated README file
   :rtype: string