Merge pull request #3 from auax/master

Master

Author: Auax

.gitignore

@@ -9,4 +9,5 @@ eggs
 parts
 src/*.egg-info
 lib
-lib64
+lib64
+.idea

resources/main.ui

@@ -430,9 +430,11 @@ p, li { white-space: pre-wrap; }
    </property>
    <widget class="QMenu" name="menu_github">
     <property name="title">
-     <string>GitHub</string>
+     <string>Options</string>
     </property>
     <addaction name="open_github"/>
+    <addaction name="report_issue"/>
+    <addaction name="donate"/>
    </widget>
    <addaction name="menu_github"/>
   </widget>
@@ -447,6 +449,16 @@ p, li { white-space: pre-wrap; }
     <string>Report a bug</string>
    </property>
   </action>
+  <action name="report_issue">
+   <property name="text">
+    <string>Report Issue</string>
+   </property>
+  </action>
+  <action name="donate">
+   <property name="text">
+    <string>Donate</string>
+   </property>
+  </action>
  </widget>
  <resources/>
  <connections/>

secauax.py

@@ -7,7 +7,14 @@
 
 
 class Secauax:
+    """
+    Secauax encryption class
+    """
+
     def __init__(self):
+        """
+        Init method
+        """
         self.key_ = Fernet.generate_key()
 
     def __str__(self):
@@ -23,7 +30,7 @@ def key(self):
     @staticmethod
     def load_key(path: Union[Path, str]) -> bytes:
         """
-        Return a key from a ".key" file.
+        Return a key from a file. This key must be valid, otherwise, an error will be thrown.
         :param path: path to key
         :return: bytes
         """
@@ -35,39 +42,42 @@ def load_key(path: Union[Path, str]) -> bytes:
 
     def load_key_into_class(self, path: Union[Path, str]):
         """
-        Replace the key class variable with loaded key.
-        File extension is ".key"
+        Replace the key class variable with the loaded key and return it.
         :param path: path to key
         :return: bytes
         """
         self.key_ = Secauax.load_key(path)
         return self.key
 
-    def save_key(self, filename: Union[Path, str]) -> None:
+    def save_key(self, filename: Union[Path, str]) -> bool:
         """
-        Save generated key to a file.
-        File extension is ".key"
+        Save set key to a file. You can choose the file extension, although the ".key" extension is recommended.
+        This method returns a true boolean if the file is saved successfully. An OSError will result in a false boolean.
         :param filename: path to save the key
-        :return: None
+        :return: bool
         """
-        with open(filename, 'wb') as filekey:
-            filekey.write(self.key)
-            filekey.close()
+        try:
+            with open(filename, 'wb') as filekey:
+                filekey.write(self.key)
+                filekey.close()
+        except OSError:
+            return False
+        return True
 
     def encrypt_file(self, path: Union[Path, str], filename: Union[Path, str] = None) -> bytes:
         """
-        Encrypt a file with a generated key.
-        DISCLAIMER: if no "filename" parameter is specified, the file will be overwritten.
-        Returns the encrypted file data in bytes.
-        :param path: path to original file
+        Encrypt a file with the set key.
+        Attention: If the filename parameter is not specified, the new file will overwrite the original.
+        It returns the encrypted file data in bytes.
+        :param path: path to the original file
         :param filename: path to save the encrypted file
         :return: bytes
         """
         fernet = Fernet(self.key)
 
         # Open original file
         with open(path, "rb") as file:
-            original_file = file.read()
+            original_file = file.read()  # Read data in bytes
             file.close()
 
         # Encrypt the file
@@ -83,27 +93,32 @@ def encrypt_file(self, path: Union[Path, str], filename: Union[Path, str] = None
     def bulk_encrypt(self,
                      pathname: Union[Path, str],
                      output_directory: Union[Path, str] = None,
-                     file_extension: str = "*") -> None:
+                     file_extension: str = "*") -> bool:
         """
-        Encrypt all files inside a directory and save them into another directory.
-        If the "output_directory" is the same as the "pathname", the files will be overwritten.
+        Encrypt all the files inside a directory and save them into another directory.
+        Attention: If the output_directory parameter is not specified, the new file(s) will overwrite the original(s).
+        This method returns a true boolean if the files are saved successfully. Any error will result in a false boolean.
         :param pathname: path to the decrypted folder
         :param output_directory: path to save the encrypted files
-        :param file_extension: select which files will be encrypted. Format: ".png" or, for all type of files: "*"
-        :return: None
+        :param file_extension: filter files by extension: ".png" / ".txt" / ...
+        :return: bool
         """
 
         assert os.path.isdir(pathname), "pathname path doesn't exist"
         assert os.path.isdir(output_directory), "output_directory path doesn't exist"
 
-        for file in glob.glob(os.path.join(pathname, file_extension)):
-            self.encrypt_file(file, os.path.join(output_directory, os.path.basename(file)))
+        try:
+            for file in glob.glob(os.path.join(pathname, file_extension)):
+                self.encrypt_file(file, os.path.join(output_directory, os.path.basename(file)))
+        except:
+            return False
+        return True
 
     def decrypt_file(self, path: Union[Path, str], filename: Union[Path, str] = None) -> bytes:
         """
-        Decrypt a file with a generated key.
-        DISCLAIMER: if no "filename" parameter is specified, the file will be overwritten.
-        Returns the decrypted file data in bytes.
+        Decrypt a file with the set key.
+        Attention: If the filename parameter is not specified, the new file will overwrite the original.
+        It returns the decrypted file data in bytes.
         :param path: path to the encrypted file
         :param filename: path to save the decrypted file
         :return: bytes
@@ -126,18 +141,23 @@ def decrypt_file(self, path: Union[Path, str], filename: Union[Path, str] = None
     def bulk_decrypt(self,
                      pathname: Union[Path, str],
                      output_directory: Union[Path, str] = None,
-                     file_extension: str = "*") -> None:
+                     file_extension: str = "*") -> bool:
         """
-        Decrypt all files inside a directory and save them into another directory.
-        If the "output_directory" is the same as the "pathname", the files will be overwritten.
+        Decrypt all the files inside a directory and save them into another directory.
+        Attention: If the output_directory parameter is not specified, the new file(s) will overwrite the original(s).
+        This method returns a true boolean if the files are saved successfully. Any error will result in a false boolean.
         :param pathname: path to encrypted folder
         :param output_directory: path to save the decrypted files
         :param file_extension: select which files will be decrypted. Format: ".png" or, for all type of files: "*"
-        :return: None
+        :return: bool
         """
 
         assert os.path.isdir(pathname), "pathname path doesn't exist"
         assert os.path.isdir(output_directory), "output_directory path doesn't exist"
 
-        for file in glob.glob(os.path.join(pathname, file_extension)):
-            self.decrypt_file(file, os.path.join(output_directory, os.path.basename(file)))
+        try:
+            for file in glob.glob(os.path.join(pathname, file_extension)):
+                self.decrypt_file(file, os.path.join(output_directory, os.path.basename(file)))
+        except:
+            return False
+        return True

window.py

@@ -36,6 +36,8 @@ def __init__(self):
 
         # Connect Menu
         self.open_github.triggered.connect(lambda: webbrowser.open("https://github.com/auax"))
+        self.report_issue.triggered.connect(lambda: webbrowser.open("https://github.com/auax/secauax/issues/new"))
+        self.donate.triggered.connect(lambda: webbrowser.open("https://paypal.me/zellius"))
 
         # Connect First Section (input path)
         self.browse_file_inp_btn.clicked.connect(lambda: self.browse_file(self.input_path))