bug fixes

Author: FRReinert

.gitignore

@@ -1,6 +1,13 @@
 
 # Created by https://www.gitignore.io/api/macos,linux,python,eclipse,pycharm,windows,sublimetext,visualstudio
 
+### Python Setup ###
+
+pyBackup.egg-info/
+dist/
+build/
+
+
 ### Eclipse ###
 
 .metadata

HISTORY.md

@@ -0,0 +1,22 @@
+#V 0.0.1
+- Initial commit
+
+# V0.0.2
+- download via <pip>
+- Email System
+- Backup Log
+- Cleaned Code
+- Minor Fixes
+
+# V0.0.3
+- Import errors
+- Script/Module mode availability
+- Reorganized codes
+- Reorganized example
+- History File
+- Changed name to pyBackup (Easier to import)
+
+#V0.0.4 [IMPORTANT CHANGES] 
+- Changed atributes name to meet good practices
+- <backup_itens> cannot be empty anymore [IMPORTANT]
+- minor fixes for importing <settings> errors

example/settings.py

@@ -31,7 +31,7 @@
 	'tls'			: True,
 }
 
-mail_subject = 'Backup System. {0}'
+mail_subject = 'Backup. {0}'
 
 mail_body = '''
 Backup System

pybackup/__init__.py

@@ -1 +1 @@
-__version__ = '0.0.2'
+__version__ = '0.0.4'

pybackup/backup.py

@@ -24,7 +24,6 @@
 '''
 
 from os import path, makedirs
-from sys import argv
 from shutil import copy, copytree, ignore_patterns
 from errno import ENOTDIR
 from . import utils 
@@ -36,42 +35,39 @@ class Backup():
 	'''
 
 	def __init__(self, verbose=False):
-		
-		# Initial attributes
-		try:
-			self.verbose 		= verbose
-			self.log 			= utils.LogSystem(verbose=verbose)
-			self.backup_list 	= []
-		
-		except BaseException as e: 
-			self.log.update_log(e)
-			raise BaseException(e)
+
+		self.verbose 		= verbose
+		self.log 			= utils.LogSystem(verbose=verbose)
+		self.backup_list 	= []
+
 
 		# Check if settings.py is properly configured and import it
 		try:
 			from settings import backup_items, sub_folder_name, target_folder, ignore_extensions, now, mailing_list, send_mail, mail_body, mail_subject, mail_settings
 
-		except ImportError as e:
-			self.log.update_log('Settings file or attributes not found')
-			raise ImportError(e)
+		except:
+			msg = 'Check if <settings.py> is in your current folder'
+			self.log.update_log(msg)
+			raise BaseException(msg) from None
+			
 
 		else:
-			self.backupItems 		= backup_items
-			self.subfolderName 		= sub_folder_name
-			self.targetFolder 		= target_folder
-			self.ignoredExtensions 	= ignore_extensions
+			self.backup_itens 		= backup_items
+			self.sub_folder_name	= sub_folder_name
+			self.target_folder 		= target_folder
+			self.ignored_extensions	= ignore_extensions
 			self.now 				= now
-			self.sendMail 			= send_mail
+			self.send_mail 			= send_mail
 
 			# Only import if <send_mail> is set to True
 			if send_mail:
-				self.mailSubject 		= mail_subject
-				self.mailBody 			= mail_body
+				self.mail_subject 		= mail_subject
+				self.mail_body 			= mail_body
 				self.mail 				= utils.MailSystem(*mailing_list, **mail_settings)
 
 				# Check mailing list
-				if len(self.mail.excludedMails) > 0:
-					self.log.update_log('Invalid mail addresses detected: %s' % self.mail.excludedMails, 'INFO')
+				if len(self.mail.excluded_list) > 0:
+					self.log.update_log('Invalid mail addresses detected: %s' % self.mail.excluded_list, 'INFO')
 
 
 	def clean_list(self):
@@ -80,14 +76,14 @@ def clean_list(self):
 		to backup
 		'''
 
-		# Case <backupItems> is empty 
-		if self.backupItems == []:
-			self.backup_list.append(path.abspath(path.dirname(argv[0])))
-
-			return None
+		# Case <backup_itens> is empty 
+		if self.backup_itens == []:
+			msg = "After version 0.0.4 <backup_itens> cannot be empty"
+			self.log.update_log(msg)
+			raise BaseException(msg) from None
 
 		# Add items
-		for item in self.backupItems:
+		for item in self.backup_itens:
 			if path.isfile(path.abspath(item)) or path.isdir(path.abspath(item)):
 				self.backup_list.append(path.abspath(item))
 			else:
@@ -99,7 +95,7 @@ def process_item(self, source, destination):
 		Backup a single item 
 		'''
 		try:
-			copytree(source, destination, ignore=ignore_patterns(*self.ignoredExtensions))
+			copytree(source, destination, ignore=ignore_patterns(*self.ignored_extensions))
 
 		except OSError as e:
 			if e.errno == ENOTDIR:
@@ -120,7 +116,7 @@ def process_list(self):
 		'''
 		Process every item from a <backup_list>
 		'''
-		default_dest = path.abspath(path.join(self.targetFolder, self.subfolderName))
+		default_dest = path.abspath(path.join(self.target_folder, self.sub_folder_name))
 
 		for item in self.backup_list:
 			if path.isdir(item):
@@ -142,9 +138,9 @@ def run(self):
 		self.process_list()
 
 		# Send email if configured to do so
-		if self.sendMail:
+		if self.send_mail:
 
-			subject = self.mailSubject.format(self.now)
-			body = self.mailBody.format(self.now, self.backupItems, self.targetFolder)
+			subject = self.mail_subject.format(self.now)
+			body = self.mail_body.format(self.now, self.backup_itens, self.target_folder)
 
 			self.mail.send(subject, body)

pybackup/utils.py

@@ -5,7 +5,7 @@
 from time import localtime, strftime
 from re import match, IGNORECASE
 
-def getDateTime():
+def get_date_time():
 	return strftime("%Y-%m-%d-%H:%M:%S", localtime())
 
 class LogSystem():
@@ -19,7 +19,7 @@ def __init__(self, verbose=False):
 		logging.basicConfig(filename='backup.log', level=logging.INFO)
 
 	def update_time(self):
-		self.now = getDateTime()
+		self.now = get_date_time()
 
 	def update_log(self, exception, type='ERROR'):
 		self.update_time()
@@ -47,15 +47,15 @@ def __init__(self, *mail_list, **config):
 
 
 		# Mailing List
-		self.mailingList = []
-		self.excludedMails = []
+		self.mailing_list = []
+		self.excluded_list = []
 
 		for item in self.mailing_list:
 			if match(r"(^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$)", item, IGNORECASE):
-				self.mailingList.append(item)
+				self.mailing_list.append(item)
 
 			else:
-				self.excludedMails.append(item)
+				self.excluded_list.append(item)
 
 		# Create SMTP object
 
@@ -64,29 +64,29 @@ def connect(self):
 		connect to SMTP server an return the SMTP object
 		'''
 		try:
-			SMTP_obj = SMTP(self.smtp_server, self.smtp_port)
+			stmp_obj = SMTP(self.smtp_server, self.smtp_port)
 
 		except SMTPException as e:
 			raise "Could not create SMTP object: %s" % e
 
 		# StartTLS
 		if self.tls:
 			try:
-				SMTP_obj.ehlo()
-				SMTP_obj.starttls()
+				stmp_obj.ehlo()
+				stmp_obj.starttls()
 
 			except SMTPException as e:
 				print("Could not open a TLS connection: %s" % e)
 
 		# login to SMTP
 		try:
-			SMTP_obj.ehlo()
-			SMTP_obj.login(self.username, self.pasword)
+			stmp_obj.ehlo()
+			stmp_obj.login(self.username, self.pasword)
 
 		except SMTPException as e:
 			print("Could not logon: %s" % e)
 
-		return SMTP_obj
+		return stmp_obj
 
 	def send(self, subject, message):
 		'''
@@ -96,12 +96,12 @@ def send(self, subject, message):
 		smtp = self.connect()
 
 		header  = 'from: %s\n' % self.mail_address
-		header += 'to: %s\n' % ','.join(self.mailingList)
+		header += 'to: %s\n' % ','.join(self.mailing_list)
 		header += 'subject: %s\n' % subject
 		message = header + '\r\n\r\n' + message
 
 		try:
-			smtp.sendmail(self.mail_address, self.mailingList, message)
+			smtp.sendmail(self.mail_address, self.mailing_list, message)
 			smtp.quit()
 
 		except SMTPException as e:

settings.py

@@ -8,18 +8,21 @@
 with open('README.md') as readme_file:
     readme = readme_file.read()
 
+with open('HISTORY.md') as history_file:
+    history = history_file.read()
+
 requirements = ['']
 
 test_requirements = [
     # TODO: put package test requirements here
 ]
 
 setup(
-    name='PyBackup',
-    version='0.0.2',
+    name='pyBackup',
+    version='0.0.4',
     description=('Python module for Backup routines'
                  'of files and folders'),
-    long_description=readme,
+    long_description=readme + '\n\n' + history,
     author="Fabricio Roberto reinert",
     author_email='fabricio.reinert@live.com',
     url='https://github.com/FRReinert/PyBackup',