add get mutiple repos (#49)

* add get_repos

* add test to get_repos

Author: Maximilian Karl

github2pandas/utility.py

@@ -27,6 +27,8 @@ class Utility():
             Save a data list to a pandas table.
         get_repo_informations(data_root_dir)
             Get a repository data (owner and name).
+        get_repos(repo_name_pattern, blacklist_pattern, token, data_root_dir)
+            Get mutiple repositorys by pattern and token.
         get_repo(repo_owner, repo_name, token, data_root_dir)
             Get a repository by owner, name and token.
         apply_datetime_format(pd_table, source_column, destination_column=None)
@@ -171,6 +173,47 @@ def get_repo_informations(data_root_dir):
                 return (repo_data["repo_owner"], repo_data["repo_name"])
         return None, None
 
+    @staticmethod
+    def get_repos(whitelist_pattern, blacklist_pattern, token, data_root_dir):
+        """
+        get_repos(repo_name_pattern, blacklist_pattern, token, data_root_dir)
+
+        Get mutiple repositorys by pattern and token.
+
+        Parameters
+        ----------
+        whitelist_pattern : str
+            the whitelist pattern of the desired repository.
+        blacklist_pattern : str
+            the blacklist pattern of the desired repository.
+        token : str
+            A valid Github Token.
+        data_root_dir : str
+            Data root directory for the repositorys.
+        
+        Returns
+        -------
+        List
+            List of Repository objects from pygithub.
+
+        Notes
+        -----
+            PyGithub Repository object structure: https://pygithub.readthedocs.io/en/latest/github_objects/Repository.html
+
+        """
+        g = github.Github(token)
+        relevant_repos = []
+        for repo in g.get_user().get_repos():
+            if whitelist_pattern == "" or whitelist_pattern == None or whitelist_pattern in repo.name:
+                if blacklist_pattern == "" or blacklist_pattern == None or not blacklist_pattern in repo.name:
+                    repo_dir = Path(data_root_dir, repo.owner.login + "/" + repo.name)
+                    repo_dir.mkdir(parents=True, exist_ok=True)
+                    repo_file = Path(repo_dir, Utility.REPO)
+                    with open(repo_file, 'w') as json_file:
+                        json.dump({"repo_owner": repo.owner.login,"repo_name":repo.name}, json_file)
+                    relevant_repos.append(repo)
+        return relevant_repos
+
     @staticmethod      
     def get_repo(repo_owner, repo_name, token, data_root_dir):
         """

tests/test_utility.py

@@ -127,6 +127,11 @@ def test_get_repo_informations(self):
         self.assertIsNone(owner)
         self.assertIsNone(name)
 
+    def test_get_repos(self):
+        warnings.simplefilter ("ignore", ResourceWarning)
+        repos = Utility.get_repos("github2pandas",None,self.github_token, "test_data")
+        self.assertNotEqual(repos,[])
+
     def test_get_repo(self):
         warnings.simplefilter ("ignore", ResourceWarning)
         repo = Utility.get_repo(self.git_repo_owner, self.git_repo_name, self.github_token, self.default_data_folder)