lukhed-basic-utils 1.0.0__tar.gz → 1.2.0__tar.gz

{lukhed_basic_utils-1.0.0 → lukhed_basic_utils-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lukhed_basic_utils
-Version: 1.0.0
+Version: 1.2.0
 Summary: A collection of basic utility functions
 Home-page: https://github.com/lukhed/lukhed_basic_utils
 Author: lukhed

{lukhed_basic_utils-1.0.0 → lukhed_basic_utils-1.2.0}/lukhed_basic_utils/githubCommon.py

@@ -1,6 +1,5 @@
 from lukhed_basic_utils import osCommon as osC
 from lukhed_basic_utils import fileCommon as fC
-from lukhed_basic_utils import commonCommon as cC
 from github import Github
 from github.Repository import Repository
 from github.GithubException import UnknownObjectException
@@ -8,7 +7,7 @@ import json
 from typing import Optional
 
 class GithubHelper:
-    def __init__(self, project='your_project_name', repo_name=None):
+    def __init__(self, project='your_project_name', repo_name=None, set_config_directory=None):
         """
         A helper class for interacting with GitHub repositories, handling authentication, 
         and various file operations within a repository.
@@ -24,6 +23,9 @@ class GithubHelper:
                 'your_project_name'. Project names are not case sensitive.
             repo_name (str, optional): Name of the repository to activate immediately
                 after instantiation. Defaults to None.
+            set_config_directory (str, optional): Full path to the directory that contains your GithubHelper config 
+                file (token file). Default is None and this class will create a directory in your working directory 
+                called 'lukhedConfig' to store the GithubHelper config file.
 
         Attributes:
             _resource_dir (str): Path to the lukhed config directory.
@@ -40,8 +42,15 @@ class GithubHelper:
     """
         
         # Check setup upon instantiation
-        cC.check_create_lukhed_config_path()
-        self._resource_dir = cC.get_lukhed_config_path()
+        if set_config_directory is None:
+            osC.check_create_dir_structure(['lukhedConfig'])
+            self._resource_dir = osC.create_file_path_string(['lukhedConfig'])
+        else:
+            self._resource_dir = set_config_directory
+            if not osC.check_if_dir_exists(self._resource_dir):
+                print(f"ERROR: The config directory '{set_config_directory}' does not exist. Exiting...")
+                quit()
+
         self._github_config_file = osC.append_to_dir(self._resource_dir, 'githubConfig.json')
         self._github_config = []
         self.user = None
@@ -55,7 +64,7 @@ class GithubHelper:
 
     
     ###################
-    # Setup/COnfig
+    # Setup/Config
     ###################
     def _check_setup(self, project):
         need_setup = True
@@ -77,9 +86,20 @@ class GithubHelper:
             self._prompt_for_setup()
 
     def _activate_project(self, project):
-        projects = [x['project'].lower() for x in self._github_config]
-        project = project.lower()
+        try:
+            projects = [x['project'].lower() for x in self._github_config]
+        except Exception as e:
+            input((f"ERROR: Error while trying to parse the config file. It may be corrupt."
+                   "You can delete the config directory and go through setup again. Press any button to quit."))
+            quit()
         
+        try:
+            project = project.lower()
+        except Exception as e:
+            input((f"ERROR: Error while trying to parse project name '{project}'. Try another project name. "
+                   "Press any button to quit."))
+            quit()
+            
         if project in projects:
             # Get the index of the item
             index = projects.index(project)
@@ -141,6 +161,10 @@ class GithubHelper:
     ###################
     # Repo Helpers
     ###################
+    def _activate_repo(self, repo_name):
+        self.repo = self._gh_object.get_repo(self.user + "/" + repo_name)
+        print(f"INFO: {repo_name} repo was activated")
+        
     def _parse_repo_dir_list_input(self, repo_dir_list):
         if repo_dir_list is None:
             repo_path = ""
@@ -161,18 +185,48 @@ class GithubHelper:
     
     def _set_repo(self, repo_name):
         try:
-            self.repo = self._gh_object.get_repo(self.user + "/" + repo_name)
-            print(f"INFO: {repo_name} repo was activated")
+            self._activate_repo(repo_name)
             return True
         except Exception as e:
-            print((f"ERROR: Error trying to set the repo to {repo_name}. Does this repo exist on your account? "
-                   f"Use the method 'get_list_of_repo_names' to see the repos in your active project."
+            print((f"ERROR: Error trying to set repo to {repo_name}. Maybe the repo does not exist in your account. "
                    f"See the full error below:\n{e}"))
+            create_repo = input(f"Do you want to create a private repo named {repo_name}? (y/n) ")
+            if create_repo == 'y':
+                if self.create_repo(repo_name, private=True):
+                    self._activate_repo(repo_name)
             
     def _get_repo_contents(self, repo_path):
         contents = self.repo.get_contents(repo_path)
         return contents
     
+    def create_repo(self, repo_name, description="Repo created by lukhed-basic-utils", private=True):
+        """
+        Creates a new repository on GitHub.
+
+        Parameters:
+            repo_name (str): The name of the repository to create.
+            description (str, optional): A brief description of the repository.
+            private (bool, optional): Determines whether the repository should be private. 
+                                      Defaults to True (private repository).
+
+        Returns:
+            bool: True if the repository was created successfully, False otherwise.
+
+        Example:
+            >>> success = obj.create_repo("my-new-repo", description="A test repo", private=True)
+        """
+        try:
+            repo = self._gh_object.get_user().create_repo(
+                name=repo_name,
+                description=description,
+                private=private
+            )
+            print(f"Repository '{repo.name}' created successfully at {repo.html_url}")
+            return True
+        except Exception as e:
+            print(f"An error occurred: {e}")
+            return False
+    
     def get_list_of_repo_names(self, print_names=False):
         """
         Returns a list of repo names available in the active project. Optionally prints the list to console.
@@ -269,14 +323,14 @@ class GithubHelper:
         else:
             return contents
 
-    def create_file(self, content, path_as_list_or_str=None, commit_message="no message"):
+    def create_file(self, content, path_as_list_or_str, commit_message="no message"):
         """
         Creates a new file in the repository with the specified content.
 
         Parameters:
             content (str | dict): The content to upload. If dict, it will be converted to JSON.
-            path_as_list_or_str (list | str, optional): Path to the file in the repository,
-            either as a list of directory segments or a single string. Defaults to None.
+            path_as_list_or_str (list | str): Path to the file in the repository,
+            either as a list of directory segments or a single string.
             commit_message (str, optional): Commit message for the new file. Defaults to "no message".
 
         Returns:
@@ -293,13 +347,13 @@ class GithubHelper:
         status = self.repo.create_file(path=repo_path, message=commit_message, content=content)
         return status
 
-    def delete_file(self, path_as_list_or_str=None, commit_message="Delete file"):
+    def delete_file(self, path_as_list_or_str, commit_message="Delete file"):
         """
         Deletes a file from the repository.
 
         Parameters:
-            path_as_list_or_str (list | str, optional): Path to the file in the repository,
-            either as a list of directory segments or a single string. Defaults to None.
+            path_as_list_or_str (list | str): Path to the file in the repository,
+            either as a list of directory segments or a single string.
             commit_message (str, optional): Commit message for the deletion. Defaults to "Delete file".
 
         Returns:
@@ -371,13 +425,13 @@ class GithubHelper:
 
         return status
 
-    def file_exists(self, repo_dir_list=None):
+    def file_exists(self, repo_dir_list):
         """
         Checks if a file exists in the repository.
 
         Parameters:
-            repo_dir_list (list | str, optional): Path to the file in the repository,
-                either as a list of directory segments or a single string. Defaults to None.
+            repo_dir_list (list | str): Path to the file in the repository,
+                either as a list of directory segments or a single string.
 
         Returns:
             bool: True if the file exists, False otherwise.
@@ -388,4 +442,5 @@ class GithubHelper:
             return False
         else:
             return True
+
         

{lukhed_basic_utils-1.0.0 → lukhed_basic_utils-1.2.0}/lukhed_basic_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lukhed-basic-utils
-Version: 1.0.0
+Version: 1.2.0
 Summary: A collection of basic utility functions
 Home-page: https://github.com/lukhed/lukhed_basic_utils
 Author: lukhed

{lukhed_basic_utils-1.0.0 → lukhed_basic_utils-1.2.0}/lukhed_basic_utils.egg-info/SOURCES.txt

@@ -3,7 +3,6 @@ README.md
 setup.py
 lukhed_basic_utils/__init__.py
 lukhed_basic_utils/classCommon.py
-lukhed_basic_utils/commonCommon.py
 lukhed_basic_utils/fileCommon.py
 lukhed_basic_utils/githubCommon.py
 lukhed_basic_utils/listWorkCommon.py

{lukhed_basic_utils-1.0.0 → lukhed_basic_utils-1.2.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="lukhed_basic_utils",
-    version="1.0.0",
+    version="1.2.0",
     description="A collection of basic utility functions",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",

lukhed_basic_utils-1.0.0/lukhed_basic_utils/commonCommon.py

@@ -1,9 +0,0 @@
-from lukhed_basic_utils import osCommon as osC
-
-config_dir = 'lukhedConfig'
-
-def check_create_lukhed_config_path():
-    osC.check_create_dir_structure([config_dir])
-
-def get_lukhed_config_path():
-    return osC.create_file_path_string([config_dir])