Create initial scaffolding for file_editability

Author: penyuan

oshminer/GitHub.py

@@ -4,6 +4,7 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 # Python Standard Library imports
+import csv
 import os
 import string
 import sys
@@ -138,6 +139,14 @@ async def get_file_list(project: dict, session) -> list:
 # Implement requestable information
 #
 
+async def get_files_editability(project: dict, session) -> dict: 
+    # Placeholder result
+    result: dict = {
+        "files_editability": "Not implemented for GitHub yet."
+    }
+
+    return result
+
 async def get_files_info(project: dict, session) -> dict: 
     """
     Return a breakdown of number of files for each file types and their 
@@ -560,6 +569,7 @@ async def get_license(project: dict, session) -> dict:
 
 # Map from request type to getter functions
 queries: dict = {
+    "files_editability": get_files_editability, 
     "files_info": get_files_info, 
     "issues_level": get_issues_level, 
     "commits_level": get_commits_level, 

oshminer/Wikifactory.py

@@ -4,6 +4,7 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 # Python Standard Library imports
+import csv
 from datetime import datetime
 import json
 import os
@@ -28,6 +29,14 @@
 WIF_API_URL_DEFAULT: str = "https://wikifactory.com/api/graphql"
 WIF_API_URL: str = os.environ.get("WIF_API_URL", WIF_API_URL_DEFAULT)
 
+async def get_files_editability(project: dict, session) -> dict: 
+    # Placeholder result
+    result: dict = {
+        "files_editability": "Not implemented for Wikifactory yet."
+    }
+
+    return result
+
 async def get_files_info(project: dict, session) -> dict:
     # Provide a GraphQL query
     query = gql(
@@ -391,6 +400,7 @@ async def get_license(project: dict, session) -> dict:
     return result
 
 queries: dict = {
+    "files_editability": get_files_editability, 
     "files_info": get_files_info, 
     "issues_level": get_issues_level, 
     "commits_level": get_commits_level, 

oshminer/main.py

@@ -29,6 +29,7 @@ class MiningRequest(BaseModel):
 # Supported data-mining request types. Items in `requested_data` must
 # be from this list.
 supported_data_requests: list = [
+    "files_editability", 
     "files_info", 
     "issues_level", 
     "commits_level",