Fix Readme creation

Author: adam3smith

README.md

@@ -54,6 +54,8 @@ Some functions, like downloading public datasets, will operate without API token
    - Under "Repository permissions", enable:
      - [x] **Actions** (Read and write)
        - Needed for triggering workflow dispatches
+     - [x] **Contents** (Read)
+       - Needed to download the README template  
      - [x] **Issues** (Read)
        - Needed for checking existing tickets, to make sure we don't create duplicates
 

docs/requirements.txt

@@ -1,2 +1,3 @@
 sphinx-autoapi
-jinja2>=3.0
+jinja2>=3.0
+importlib_resources; python_version < '3.9'

dvcurator/gui.py

@@ -350,7 +350,7 @@ def create_readme(self):
 
 		self.disable_buttons()
 		t = threading.Thread(target=dvcurator.readme.generate_readme, 
-			args=(self.metadata, os.path.join(self.subfolder_path, "QDR Prepared"), self.dv_token.get(), self.curation_repo.get()))
+			args=(self.metadata, os.path.join(self.subfolder_path, "QDR Prepared"), self.dv_token.get(), self.gh_token.get(), self.curation_repo.get()))
 		t.start()
 		self.schedule_check(t)
 
@@ -473,8 +473,16 @@ def __init__(self, parent, *args, **kwargs):
 			parent.iconbitmap(bitmap=icon)
 		else:
 			self.local_ini = os.path.join(os.getcwd(), "dvcurator.ini")
-			from pkg_resources import resource_filename
-			icon = resource_filename("dvcurator", "assets/qdr.ico")
+			try:
+                # Modern approach using importlib.resources
+				from importlib import resources
+				with resources.path("dvcurator", "assets") as assets_path:
+					icon = str(assets_path / "qdr.ico")
+			except ImportError:
+				# Fallback for Python < 3.9
+				from importlib_resources import files
+				icon = str(files("dvcurator") / "assets" / "qdr.ico")
+			parent.iconbitmap(bitmap=icon)
 
 		if os.path.exists(self.local_ini):
 			self.load_config(self.local_ini)		

dvcurator/readme.py

@@ -13,18 +13,22 @@ def clean_html_tags(text):
     clean_text = re.sub(tags, '', text)
     return clean_text
 
-def generate_readme(metadata, folder, token=None, repo=None):
+def generate_readme(metadata, folder, token=None, key=None, repo=None):
     """
     Generate README.txt file. 
     
-    This function uses the template assets/README.txt
+    This function uses the file README_template.txt in the repository root.
 
     :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
+    :param key: Github API key, or None for public repository
+    :type key: String or None
+    :param repo: Repository to use for the README template, defaults to dvcurator.hosts.curation_repo
+    :type repo: String or None
 
     :return: Path to newly generated README file
     :rtype: string
@@ -78,14 +82,22 @@ def generate_readme(metadata, folder, token=None, repo=None):
         'files': dvcurator.fs.recursive_scan(folder) #"\n".join(os.listdir(folder))
     }
 
-    # the location of the template differs if this is a compiled pyinstaller file or run directly
-    
+
     ## Download readme template from github
+
+    
     host = "https://raw.githubusercontent.com/"
     repo = dvcurator.hosts.curation_repo if not repo else repo
     readme_url = host + repo + "/refs/heads/master/README_template.txt"
 
-    response = requests.get(readme_url)
+    if (not key):
+        print("No github token set -- this will fail on private repo")
+        response = requests.get(readme_url)
+    else:
+        print("Trying to download README template from private repository...")
+        key = {'Authorization': "token " + key.strip()}
+        response = requests.get(readme_url, headers=key)
+
     response.raise_for_status()
     readme_template = response.text
     print("Downloaded README template...")