[Update] Clean code, minor fixes

Author: FRReinert

__init__.py

@@ -1,12 +1,6 @@
 # -*- coding: utf-8 -*-
 
-'''
-IF YOU INSTALLED PYBACKUP WITH PIP
-YOU'LL BE ABLE TO IMPORT IT FROM <PyBackup>
-THIS EXAMPLE SHOWS HOW TO WORK IT IN THAT WAY
-'''
-
-import PyBackup
+from pybackup.backup import Backup
 
 bkp = Backup(verbose=True)
 bkp.Run()

example/backup.py

@@ -0,0 +1 @@
+__version__ = '0.0.2'

pybackup/__init__.py

@@ -23,17 +23,18 @@
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 '''
 
-from os import path, makedirs, scandir
+from os import path, makedirs
 from sys import argv
 from shutil import copy, copytree, ignore_patterns
 from errno import ENOTDIR
-import utils 
+from . import utils 
 
 
 class Backup():
 	'''
 	Main class of the backup system
 	'''
+
 	def __init__(self, verbose=False):
 
 		# Initial attributes
@@ -43,15 +44,15 @@ def __init__(self, verbose=False):
 			self.backup_list 	= []
 
 		except BaseException as e: 
-			self.log.UpdateLog(e)
+			self.log.update_log(e)
 			raise BaseException(e)
 
 		# 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.UpdateLog(e)
+			self.log.update_log('Settings file or attributes not found')
 			raise ImportError(e)
 
 		else:
@@ -70,10 +71,10 @@ def __init__(self, verbose=False):
 
 				# Check mailing list
 				if len(self.mail.excludedMails) > 0:
-					self.log.UpdateLog('Invalid mail addresses detected: %s' % self.mail.excludedMails, 'INFO')
+					self.log.update_log('Invalid mail addresses detected: %s' % self.mail.excludedMails, 'INFO')
 
 
-	def CleanList(self):
+	def clean_list(self):
 		'''
 		Manage the list of items
 		to backup
@@ -82,18 +83,18 @@ def CleanList(self):
 		# Case <backupItems> is empty 
 		if self.backupItems == []:
 			self.backup_list.append(path.abspath(path.dirname(argv[0])))
-			
+
 			return None
 
 		# Add items
 		for item in self.backupItems:
 			if path.isfile(path.abspath(item)) or path.isdir(path.abspath(item)):
 				self.backup_list.append(path.abspath(item))
 			else:
-				log.UpdateLog("Invalid item. It'll be wiped from backup list: <%s>" % item, 'INFO')
+				log.update_log("Invalid item. It'll be wiped from backup list: <%s>" % item, 'INFO')
 
 
-	def ProcessItem(self, source, destination):
+	def process_item(self, source, destination):
 		'''
 		Backup a single item 
 		'''
@@ -106,16 +107,16 @@ def ProcessItem(self, source, destination):
 					copy(source, destination)
 
 				except:
-					log.UpdateLog("Error processing file <%s>: <%s>" % (source, e))
+					log.update_log("Error processing file <%s>: <%s>" % (source, e))
 
 			else:
-				self.log.UpdateLog("Source <%s> could not be copied to <%s>: <%s>" % (source, destination, e))
+				self.log.update_log("Source <%s> could not be copied to <%s>: <%s>" % (source, destination, e))
 
 		except BaseException as e:
-			self.log.UpdateLog("Unkown error copying <%s>: <%s>" % (source, e))
+			self.log.update_log("Unkown error copying <%s>: <%s>" % (source, e))
 
 
-	def ProcessList(self):
+	def process_list(self):
 		'''
 		Process every item from a <backup_list>
 		'''
@@ -125,33 +126,25 @@ def ProcessList(self):
 			if path.isdir(item):
 				folder = path.abspath(item).split('\\')[-1]
 				dest = path.join(default_dest, folder)
-				self.log.UpdateLog('Processing directory: %s' % item, 'INFO')
-				self.ProcessItem(path.abspath(item), dest)
+				self.log.update_log('Processing directory: %s' % item, 'INFO')
+				self.process_item(path.abspath(item), dest)
 
 			else:
-				self.log.UpdateLog('Processing file: %s' % item, 'INFO')
-				self.ProcessItem(path.abspath(item), default_dest)
+				self.log.update_log('Processing file: %s' % item, 'INFO')
+				self.process_item(path.abspath(item), default_dest)
 
 
-	def Run(self):
+	def run(self):
 		'''
 		Run backup routine
 		'''
-		self.CleanList()
-		self.ProcessList()
+		self.clean_list()
+		self.process_list()
 
 		# Send email if configured to do so
 		if self.sendMail:
 
 			subject = self.mailSubject.format(self.now)
 			body = self.mailBody.format(self.now, self.backupItems, self.targetFolder)
 
-			self.mail.Send(subject, body)
-
-
-
-# Debug purpose 
-if __name__ == "__main__":
-
-	Bkp = Backup(verbose=True)
-	Bkp.Run()
+			self.mail.send(subject, body)

backup.py pybackup/backup.pybackup.py renamed to pybackup/backup.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+from time import localtime, strftime 
+
+sub_folder_name = strftime("%Y_%m_%d_%H%M%S", localtime())
+
+now = strftime("%Y-%m-%d %H:%M:%S", localtime())
+
+backup_items = []
+
+mailing_list = []
+
+ignore_extensions = ['*.py','*.pyc', '*.log']
+
+target_folder = ''
+
+send_mail = True
+
+mail_settings = {
+	'server'		: 'smtp.live.com',
+	'port'			: 25,
+	'mail_address'	: '@live.com',
+	'username'		: '@live.com',
+	'password'		: '',
+	'tls'			: True,
+}
+
+mail_subject = 'Backup System. {0}'
+
+mail_body = '''
+Backup System
+
+	Backup Performed at:	{0}
+	Backup Items:	{1}
+	Destination folder:	{2}
+'''

pybackup/settings.py

@@ -18,11 +18,11 @@ def __init__(self, verbose=False):
 		self.verbose = verbose
 		logging.basicConfig(filename='backup.log', level=logging.INFO)
 
-	def UpdateTime(self):
+	def update_time(self):
 		self.now = getDateTime()
 
-	def UpdateLog(self, exception, type='ERROR'):
-		self.UpdateTime()
+	def update_log(self, exception, type='ERROR'):
+		self.update_time()
 		msg = self.now+': '+exception
 		if type == 'ERROR':
 			logging.error(msg)
@@ -59,7 +59,7 @@ def __init__(self, *mail_list, **config):
 
 		# Create SMTP object
 
-	def Connect(self):
+	def connect(self):
 		'''
 		connect to SMTP server an return the SMTP object
 		'''
@@ -88,12 +88,12 @@ def Connect(self):
 
 		return SMTP_obj
 
-	def Send(self, subject, message):
+	def send(self, subject, message):
 		'''
 		Send email to mailing list
 		'''
 
-		smtp = self.Connect()
+		smtp = self.connect()
 
 		header  = 'from: %s\n' % self.mail_address
 		header += 'to: %s\n' % ','.join(self.mailingList)

utils.py pybackup/utils.pyutils.py renamed to pybackup/utils.py

@@ -0,0 +1,41 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+
+from setuptools import setup, find_packages
+
+
+with open('README.md') as readme_file:
+    readme = readme_file.read()
+
+requirements = ['']
+
+test_requirements = [
+    # TODO: put package test requirements here
+]
+
+setup(
+    name='PyBackup',
+    version='0.0.2',
+    description=('Python module for Backup routines'
+                 'of files and folders'),
+    long_description=readme,
+    author="Fabricio Roberto reinert",
+    author_email='fabricio.reinert@live.com',
+    url='https://github.com/FRReinert/PyBackup',
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=requirements,
+    license="MIT license",
+    zip_safe=False,
+    keywords='Python, backup, files, folders',
+    classifiers=[
+        'Development Status :: 2 - Pre-Alpha',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Natural Language :: English',
+        'Programming Language :: Python :: 3.6',
+    ],
+    test_suite='tests.test_app.tests',
+    tests_require=test_requirements
+)