add long description and categories to setup.py #15

Author: Luiko Czub

README.md

@@ -9,32 +9,31 @@ License [Apache License 2.0]
 Introduction
 ------------
 
-TestLink-API-Python-client is a Python XMLRPC client for the [TestLink API].
+TestLink-API-Python-client is a Python XML-RPC client for [TestLink].
 
-Initially based on the James Stock testlink-api-python-client R7 and  Olivier 
+Initially based on James Stock testlink-api-python-client R7 and  Olivier 
 Renault [JinFeng] idea - an interaction of [TestLink], [Robot Framework] and [Jenkins].
 
 TestLink-API-Python-client delivers two main classes
-*   TestlinkAPIGeneric - Implements the Testlink API methods as generic PY 
-    methods with error handling.
-    *   Allows the configuration of arguments for these API method as positional
-        or optional arguments.
-    
-*   TestlinkAPIClient - Inherits Testlink API methods from the generic client
-    TestlinkAPIGeneric and defines service methods like "countProjects".
-    *   Change the configuration for positional and optional arguments in a way, 
-        that often used arguments are positional (consistent with v0.4.0).
+
+- TestlinkAPIGeneric - Implements the TestLink API methods as generic PY methods
+  with error handling
+- TestlinkAPIClient - Inherits from TestlinkAPIGeneric and defines service 
+  methods like "countProjects".
 
 Directory Layout
 ----------------
 
 src/
+
 *   Source for TestLink API Python Client
 
 tests/
+
 *   Unit Tests for TestLink API Python Client
 
 examples/
+
 *   Examples, how to use the TestLink API Python Client
 
 Installation
@@ -58,7 +57,7 @@ pip install TestLink-0.4.5.zip
 Usage
 -----
 
-### Connect TestLink in a python shell
+### How to talk with TestLink in a python shell
 
 ```
 [PYENV]\testlink\Scripts\activate
@@ -127,9 +126,9 @@ Questions, Enhancements, Issues are welcome under [Issues]
 
 For (nearly all) implemented API methods you find in 
 [example/TestLinkExample.py](example/TestLinkExample.py) 
-an example, which although prints the reponse.
+an example, how to call it and how the response looks like.
 
-The Teslink API Client can be asked, what arguments a API method expects
+The TestLink API Client can be asked, what arguments a API method expects
 
 ```
 import testlink

setup.py

@@ -11,14 +11,69 @@
 
 execfile(join(dirname(__file__), 'src', 'testlink', 'version.py'))
 
-setup(name='TestLink',
+CLASSIFIERS = [
+  'Development Status :: 4 - Beta',
+  'License :: OSI Approved :: Apache License V2.0',
+  'Operating System :: OS Independent',
+  'Programming Language :: Python',
+  'Topic :: Formats and Protocols :: Protocols :: XML-RPC',
+  'Topic :: Software Development :: Testing',
+  'Topic :: Software Development :: Libraries :: Python Modules'
+]
+
+DESCRIPTION = """
+TestLink-API-Python-client is a Python XML-RPC client for TestLink_.
+
+Initially based on James Stock testlink-api-python-client R7 and  Olivier 
+Renault JinFeng_ idea - an interaction of TestLink_, `Robot Framework`_ and Jenkins_.
+
+TestLink-API-Python-client delivers two main classes
+
+- TestlinkAPIGeneric - Implements the TestLink API methods as generic PY methods
+  with error handling
+- TestlinkAPIClient - Inherits from TestlinkAPIGeneric and defines service 
+  methods like "countProjects".
+
+and the helper class
+
+- TestLinkHelper - search connection parameter from environment variables and 
+  command line arguments
+  
+How to talk with TestLink in a python shell: ::
+
+ set TESTLINK_API_PYTHON_SERVER_URL=http://[YOURSERVER]/testlink/lib/api/xmlrpc/v1/xmlrpc.php
+ set TESTLINK_API_PYTHON_DEVKEY=[Users devKey generated by TestLink]
+ python
+ >>> import testlink
+ >>> tls = testlink.TestLinkHelper().connect(testlink.TestlinkAPIClient)
+ >>> tls.countProjects()
+ 3
+ >>> tls.getTestCase(None, testcaseexternalid='NPROAPI3-1')
+ [{'full_tc_external_id': 'NPROAPI3-1', 'node_order': '0', 'is_open': '1', 'id': '2757', ...}]
+ 
+More information about this library can be found on the Wiki_ 
+
+.. _TestLink: http://testlink.org
+.. _JinFeng: http://www.sqaopen.net/blog/en/?p=63
+.. _Robot Framework: http://code.google.com/p/robotframework
+.. _Jenkins: http://jenkins-ci.org
+.. _Wiki: https://github.com/lczub/TestLink-API-Python-client/wiki
+
+"""[1:-1]
+
+setup(name='TestLink-API-Python-client',
       version=VERSION,
-      description='Python XMLRPC client for the TestLink API',
+      description='Python XML-RPC client for TestLink',
+      long_description = DESCRIPTION,
       author='James Stock, Olivier Renault, Luiko Czub, TestLink-API-Python-client developers',
       author_email='[email protected], [email protected]',
       url='https://github.com/lczub/TestLink-API-Python-client',
       license      = 'Apache 2.0',
       package_dir  = {'': 'src'},
-      packages=['testlink'],
+      packages     = ['testlink'],
+      classifiers  = CLASSIFIERS,
+      platforms    = 'any',
+      keywords     = ['testing', 'testlink', 'xml-rpc', 'testautomation']
+      
      )
 

src/testlink/testlinkapi.py

@@ -23,9 +23,9 @@
 
 
 class TestlinkAPIClient(TestlinkAPIGeneric):
-    """ client for xmlrpc communication between Python and TestLlink 
+    """ client for XML-RPC communication between Python and TestLink 
     
-        Inherits Testlink API methods from the generic client TestlinkAPIGeneric.
+        Inherits TestLink API methods from the generic client TestlinkAPIGeneric.
         
         Defines Service Methods like "countProjects" and change the 
         configuration for positional and optional arguments in a way, that often

src/testlink/testlinkapigeneric.py

@@ -27,8 +27,8 @@
 
 
 class TestlinkAPIGeneric(object): 
-    """ client for xmlrpc communication between Python and TestLlink 
-        Implements the Testlink API methods as generic PY methods with 
+    """ client for XML-RPC communication between Python and TestLink 
+        Implements the TestLink API methods as generic PY methods with 
         error handling.
         
         Allows the configuration of arguments for these API method as positional
@@ -1069,7 +1069,7 @@ def whatArgs(self, methodNameAPI):
 
     def __str__(self):
         message = """
-Testlink API - class %s - version %s
+TestLink API - class %s - version %s
 @authors: %s
 
 Current connection settings

src/testlink/testlinkhelper.py

@@ -24,7 +24,7 @@
 
 class TestLinkHelper(object):
     """ Helper Class to find out the TestLink connection parameters.
-    a) TestLink Server URL of XMLRPC
+    a) TestLink Server URL of XML-RPC
        environment variable - TESTLINK_API_PYTHON_SERVER_URL
        default value        - http://localhost/testlink/lib/api/xmlrpc.php
        command line arg     - server_url
@@ -47,7 +47,7 @@ class TestLinkHelper(object):
       tl_helper.connect(TestLink) 
       -> returns a TestLink instance
     
-    Attention: TL 197 changed the URL of XMLRPC 
+    Attention: TL 197 changed the URL of XML-RPC 
       from  http://localhost/testlink/lib/api/xmlrpc.php
       to    http://localhost/testlink/lib/api/xmlrpc/v1/xmlrpc.php
     """
@@ -58,7 +58,7 @@ class TestLinkHelper(object):
     ENVNAME_DEVKEY      = 'TESTLINK_API_PYTHON_DEVKEY'
     DEFAULT_SERVER_URL  = 'http://localhost/testlink/lib/api/xmlrpc.php'
     DEFAULT_DEVKEY      = '42'
-    DEFAULT_DESCRIPTION = 'Python XMLRPC client for the TestLink API v%s' \
+    DEFAULT_DESCRIPTION = 'Python XML-RPC client for the TestLink API v%s' \
                             % VERSION
 
     def __init__(self, server_url=None, devkey=None):
@@ -91,7 +91,7 @@ def _createArgparser(self, usage):
         a_parser = ArgumentParser( description=usage)
         # optional command line parameters
         a_parser.add_argument('--server_url', default=self._server_url,
-                help='TestLink Server URL of XMLRPC (default: %(default)s) ')
+                help='TestLink Server URL of XML-RPC (default: %(default)s) ')
         # pseudo optional command line parameters, 
         # must be set individual for each user
         a_parser.add_argument('--devKey', default=self._devkey,

src/testlink/version.py

@@ -17,4 +17,4 @@
 #
 # ------------------------------------------------------------------------
 
-VERSION = '0.4.5'
+VERSION = '0.4.6-DEV-15'