Adding PEP8 compliance to the code and preparing new pip version(0.1.3)

CHANGES.txt

@@ -1,2 +1,3 @@
 v0.1,  11/01/2016 -- Initial release.
 v0.1.2, 11/09/2016 -- Providing full documentation.
+v0.1.3, 11/17/2016 -- Adding PEP8 compliance to most of the code.

LICENSE

@@ -631,7 +631,7 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    remoteMultiCommand - Provides execution of multiple commands in multiple servers in parallel (multiple processes)
+    remote_multicommand - Provides execution of multiple commands in multiple servers in parallel (multiple processes)
     Copyright (C) 2016   Jonatan Dellagostin
 
     This program is free software: you can redistribute it and/or modify
@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    remoteMultiCommand  Copyright (C) 2016  Jonatan Dellagostin
+    remote_multicommand  Copyright (C) 2016  Jonatan Dellagostin
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

README.rst

@@ -1,32 +1,32 @@
-.. image:: https://readthedocs.org/projects/remotemulticommand/badge/?version=master
-   :target: http://remotemulticommand.readthedocs.io/en/master/?badge=master
+.. image:: https://readthedocs.org/projects/remote_multicommand/badge/?version=master
+   :target: http://remote_multicommand.readthedocs.io/en/master/?badge=master
    :alt: Documentation Status
 
-.. image:: https://coveralls.io/repos/github/jonDel/remoteMultiCommand/badge.svg?branch=master
-   :target: https://coveralls.io/github/jonDel/remoteMultiCommand?branch=master
+.. image:: https://coveralls.io/repos/github/jonDel/remote_multicommand/badge.svg?branch=master
+   :target: https://coveralls.io/github/jonDel/remote_multicommand?branch=master
 
-.. image:: https://landscape.io/github/jonDel/remoteMultiCommand/master/landscape.svg?style=flat
-    :target: https://landscape.io/github/jonDel/remoteMultiCommand/master
+.. image:: https://landscape.io/github/jonDel/remote_multicommand/master/landscape.svg?style=flat
+    :target: https://landscape.io/github/jonDel/remote_multicommand/master
     :alt: Code Health
 
-.. image:: https://www.versioneye.com/user/projects/582340127a72950047198059/badge.svg?style=flat
-    :target: https://www.versioneye.com/user/projects/582340127a72950047198059
+.. image:: https://www.versioneye.com/user/projects/582ddf73c8dd3300448f9e81/badge.svg?style=flat
+    :target: https://www.versioneye.com/user/projects/582ddf73c8dd3300448f9e81
 
 
-remoteMultiCommand
-==================
+remote_multicommand
+===================
 
-**remoteMultiCommand** provides execution of multiple commands in multiple servers in parallel (multiple processes)
+**remote_multicommand** provides execution of multiple commands in multiple servers in parallel (multiple processes)
 
 
 Executing a list of commands in multiple servers in parallel
 ------------------------------------------------------------
 
 .. code:: python
 
-  >>> from remoteMultiCommand import remoteMultiCommand
+  >>> from remote_multicommand import remote_multicommand
   >>> cmdsList = ['hostname','whoami']
-  >>> rmCmd = remoteMultiCommand('/tmp/sshkey')
+  >>> rmCmd = remote_multicommand('/tmp/sshkey')
   Log: Changing log level to ERROR | Log level:ERROR | Date:01/11/2016 16:40:10
   >>> rmCmd.set_log_level('DEBUG')
   Log: Changing log level to DEBUG | Log level:DEBUG | Date:01/11/2016 16:40:12
@@ -83,25 +83,25 @@ Executing a list of commands in multiple servers in parallel
 Installation
 ------------
 
-To install remoteMultiCommand, simply run:
+To install remote_multicommand, simply run:
 
 ::
 
-  $ pip install remoteMultiCommand
+  $ pip install remote_multicommand
 
-remoteMultiCommand is compatible with Python 2.6+
+remote_multicommand is compatible with Python 2.6+
 
 Documentation
 -------------
 
-https://remoteMultiCommand.readthedocs.io
+https://remote_multicommand.readthedocs.io
 
 Source Code
 -----------
 
 Feel free to fork, evaluate and contribute to this project.
 
-Source: https://github.com/jonDel/remoteMultiCommand
+Source: https://github.com/jonDel/remote_multicommand
 
 License
 -------

docs/Makefile

@@ -50,7 +50,7 @@ clean:
 
 .PHONY: rst
 rst:
-	sphinx-apidoc -f -o source ../remoteMultiCommand
+	sphinx-apidoc -f -o source ../remote_multicommand
 
 .PHONY: html
 html:
@@ -95,9 +95,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/remoteMultiCommand.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/remote_multicommand.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/remoteMultiCommand.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/remote_multicommand.qhc"
 
 .PHONY: applehelp
 applehelp:
@@ -114,8 +114,8 @@ devhelp:
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/remoteMultiCommand"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/remoteMultiCommand"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/remote_multicommand"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/remote_multicommand"
 	@echo "# devhelp"
 
 .PHONY: epub

docs/make.bat

@@ -129,9 +129,9 @@ if "%1" == "qthelp" (
 	echo.
 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
 .qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\remoteMultiCommand.qhcp
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\remote_multicommand.qhcp
 	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\remoteMultiCommand.ghc
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\remote_multicommand.ghc
 	goto end
 )
 

docs/source/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# remoteMultiCommand documentation build configuration file, created by
+# remote_multicommand documentation build configuration file, created by
 # sphinx-quickstart on Fri Nov  4 16:58:46 2016.
 #
 # This file is execfile()d with the current directory set to its
@@ -57,7 +57,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'remoteMultiCommand'
+project = u'remote_multicommand'
 copyright = u'2016, Jonatan Dellagostin'
 author = u'Jonatan Dellagostin'
 
@@ -66,9 +66,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'0.1.2'
+version = u'0.1.3'
 # The full version, including alpha/beta/rc tags.
-release = u'0.1.2'
+release = u'0.1.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -145,7 +145,7 @@
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
 #
-# html_title = u'remoteMultiCommand v0.1'
+# html_title = u'remote_multicommand v0.1.3'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #
@@ -245,7 +245,7 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'remoteMultiCommanddoc'
+htmlhelp_basename = 'remote_multicommanddoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -271,7 +271,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'remoteMultiCommand.tex', u'remoteMultiCommand Documentation',
+    (master_doc, 'remote_multicommand.tex', u'remote_multicommand Documentation',
      u'Jonatan Dellagostin', 'manual'),
 ]
 
@@ -313,7 +313,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'remotemulticommand', u'remoteMultiCommand Documentation',
+    (master_doc, 'remotemulticommand', u'remote_multicommand Documentation',
      [author], 1)
 ]
 
@@ -328,8 +328,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'remoteMultiCommand', u'remoteMultiCommand Documentation',
-     author, 'remoteMultiCommand', 'One line description of project.',
+    (master_doc, 'remote_multicommand', u'remote_multicommand Documentation',
+     author, 'remote_multicommand', 'One line description of project.',
      'Miscellaneous'),
 ]
 

docs/source/index.rst

@@ -1,15 +1,15 @@
-Welcome to remoteMultiCommand's documentation
-=============================================
+Welcome to remote_multicommand's documentation
+==============================================
 
 .. include:: ../../README.rst
 
-remoteMultiCommand package contents:
-====================================
+remote_multicommand package contents:
+=====================================
 
 .. toctree::
    :maxdepth: 2
-   
-   remoteMultiCommand
+
+   remote_multicommand
 
 Indices and tables
 ==================

docs/source/remote_multicommand.rst

@@ -0,0 +1,22 @@
+remote_multicommand package
+===========================
+
+Submodules
+----------
+
+remote_multicommand.remote_multicommand module
+----------------------------------------------
+
+.. automodule:: remote_multicommand.remote_multicommand
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: remote_multicommand
+    :members:
+    :undoc-members:
+    :show-inheritance:

setup.py

@@ -2,10 +2,10 @@
 
 setup(
     name='remote_multicommand',
-    version='0.1.2',
+    version='0.1.3',
     author='Jonatan Dellagostin',
     author_email='jdellagostin@gmail.com',
-    url='https://github.com/jonDel/remoteMultiCommand',
+    url='https://github.com/jonDel/remote_multicommand',
     packages=['remote_multicommand'],
     license='GPLv3',
     description='Provides execution of multiple commands in multiple servers in parallel (multiple processes)',