Merge pull request #5 from tylercrumpton/prep/for-v1.2.0

Add support for py3.

Author: tylercrumpton

README.md

@@ -0,0 +1,84 @@
+robotframework-scplibrary
+=========================
+
+|PyPI version| |PyPI license| |PyPI pyversions|
+
+
+Robot Framework test library for Secure Copy (SCP)
+--------------------------------------------------
+
+This library can be used to copy files to and from a remote machine
+using Secure Copy (SCP). It uses the Paramiko SSH Python library (just
+like robotframework-sshlibrary) and an SCP wrapper (‘scp’ by James
+Bardin).
+
+The library does not currently support Jython or IronPython at this
+time.
+
+Installation
+------------
+
+This library may be installed via PyPI or from the source distribution.
+To install using pip, run:
+
+::
+
+   pip install robotframework-scplibrary
+
+To install from the source distribution, download the repo archive and
+extract the source and run:
+
+::
+
+   python setup.py install
+
+Example
+-------
+
+.. code::
+
+   *** Settings ***
+   Library   SCPLibrary
+
+   *** Test Cases ***
+   Grab Files From My Server
+       Open Connection   192.168.1.42    username=tyler  password=teapot
+       Get File          remotefile.txt  localfile.txt
+       Get File          /home/tyler/    mytylerdir/     recursive=True
+       Close Connection
+
+   Put File On My Server
+       Open Connection   192.168.1.42    username=tyler  password=teapot
+       Put File          mytea.txt       /home/tyler/
+       Close Connection
+
+Connection
+----------
+
+Before files can be transferred, a connection to remote machine must
+first be made. A connection can be made with the ``Open Connection``
+keyword. Both normal username/password authentication and asymmetric
+key-pair authentication may be used.
+
+Connections should be closed using the ``Close Connection`` keyword when
+they are no longer in use.
+
+File transfer
+-------------
+
+Files and directories can be uploaded to the remote machine using the
+``Put File`` or ``Put Directory`` keywords or downloaded to the local
+machine using the ``Get File`` keyword.
+
+A connection must be made using the ``Open Connection`` keyword before
+file transfers may be made.
+
+.. |PyPI version| image:: https://img.shields.io/pypi/v/robotframework-scplibrary.svg
+   :target: https://pypi.org/project/robotframework-scplibrary/
+
+.. |PyPI license| image:: https://img.shields.io/pypi/l/robotframework-scplibrary.svg
+   :target: https://pypi.org/project/robotframework-scplibrary/
+
+.. |PyPI pyversions| image:: https://img.shields.io/pypi/pyversions/robotframework-scplibrary.svg
+   :target: https://pypi.org/project/robotframework-scplibrary/
+

README.rst

@@ -1,14 +1,19 @@
 from paramiko import SSHClient
 from paramiko.client import AutoAddPolicy
 from scp import SCPClient
-from errors import SCPNotConnectedError
+from six import string_types
 
 try:
     from _version import __version__, __revision__
 except ImportError:
     __version__ = "UNKNOWN"
     __revision__ = "UNKNOWN"
 
+
+class SCPNotConnectedError(RuntimeError):
+    ROBOT_EXIT_ON_FAILURE = False
+
+
 class SCPLibrary(object):
     """Robot Framework test library for Secure Copy (SCP).
 
@@ -130,6 +135,6 @@ def get_file(self, remote_filepath, local_filepath, recursive=False):
 
     @staticmethod
     def _is_true_arg(arg):
-        if isinstance(arg, basestring):
+        if isinstance(arg, string_types):
             return arg.lower() not in ['false', 'no']
         return bool(arg)

SCPLibrary/errors.py

@@ -1,4 +1,4 @@
-paramiko==1.15.2
-scp==0.10.2
+paramiko==2.4.1
+scp==0.11.0
 robotframework==2.8.7
 vcversioner==2.14.0.0

SCPLibrary/library.py

@@ -1,16 +1,32 @@
+from os import path
+from io import open
 from setuptools import setup
 
+
+here = path.abspath(path.dirname(__file__))
+
+# Get the long description from the README file
+with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
+    LONG_DESCRIPTION = f.read()
+
 config = {
     'description': 'Robot Framework test library for transferring files via Secure Copy (SCP)',
     'author': 'Tyler Crumpton',
-    'url': 'http://www.tylercrumpton.com',
+    'url': 'https://www.tylercrumpton.com',
     'download_url': 'https://github.com/tylercrumpton/robotframework-scplibrary',
     'author_email': '[email protected]',
     'vcversioner': {'version_module_paths': ['SCPLibrary/_version.py']},
-    'install_requires': ['scp', 'paramiko'],
+    'install_requires': ['scp', 'paramiko', 'six'],
     'packages': ['SCPLibrary'],
     'scripts': [],
-    'name': 'robotframework-scplibrary'
+    'name': 'robotframework-scplibrary',
+    'license': 'GPLv3',
+    'long_description': LONG_DESCRIPTION,
+    'project_urls': {
+        'Bug Reports': 'https://github.com/tylercrumpton/robotframework-scplibrary/issues',
+        'Source': 'https://github.com/tylercrumpton/robotframework-scplibrary',
+    },
+
 }
 
 setup(**config)