Merge pull request #1 from lczub/master

new TestLink-API-Python-client release candidate v0.4.5-RC1

Author: citizen-stig

MANIFEST.in

@@ -1,4 +1,5 @@
 include MANIFEST.in LICENSE-2.0.txt README.md
 recursive-include src *.py
 recursive-include example *.py
+recursive-include example *.png
 recursive-include test *.py

README.md

@@ -1,8 +1,8 @@
 TestLink API Python Client
 ==========================
 
-Copyright 2011-2012 
-James Stock, Olivier Renault, TestLink-API-Python-client developers
+Copyright 2011-2013 
+James Stock, Olivier Renault, Luiko Czub, TestLink-API-Python-client developers
 
 License [Apache License 2.0]
 
@@ -11,11 +11,19 @@ Introduction
 
 TestLink-API-Python-client is a Python XMLRPC client for the [TestLink API].
 
-It's a brick of Olivier Renault [JinFeng] idea - an interaction of [TestLink], 
- [Robot Framework] and [Jenkins].
-
-Initially based on the James Stock testlink-api-python-client R7.
+Initially based on the 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).
 
 Directory Layout
 ----------------
@@ -32,12 +40,19 @@ examples/
 Installation
 ------------
 
+### TestLink configuration
+The testLink configuration (config.inc.php or custom_config.inc.php) must have enabled the api interface
+*   $tlCfg->api->enabled = TRUE;
+   
+The user specific devKey are created inside TestLink, see
+*   My Settings -> API interface - Personal API access key [Generate a new key]
+
 ### Install TestLinkAPI into a virtualenv environment
 
 ```
 [PYTHON27]\Scripts\virtualenv [PYENV]\testlink
 [PYENV]\testlink\Scripts\activate
-python setup.py install
+pip install TestLink-0.4.5-RC1.zip
 ```
 
 ### Run example with command line arguments
@@ -48,6 +63,12 @@ python example\TestLinkExample.py
                --server_url http://[YOURSERVER]/testlink/lib/api/xmlrpc.php
                --devKey [Users devKey generated by TestLink]
 ```
+```
+[PYENV]\testlink\Scripts\activate
+python example\TestLinkExampleGenericApi.py
+               --server_url http://[YOURSERVER]/testlink/lib/api/xmlrpc.php
+               --devKey [Users devKey generated by TestLink]
+```
 
 ### Run unittests with TestLink Server interaction
 
@@ -75,13 +96,44 @@ Use http://[YOURSERVER]/testlink/lib/api/xmlrpc/v1/xmlrpc.php
 Download
 --------
 
-see [downloads]
+see [Releases]
+*    please read [v0.4.5 release notes](https://github.com/lczub/TestLink-API-Python-client/releases/tag/v0.4.5-RC1)
+     for changes between v0.4.0 and v0.4.5    
+
+Help
+----
+
+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.
+
+The Teslink API Client could be ask, what arguments a API method expects
+
+```
+import testlink
+tlh = testlink.TestLinkHelper()
+tls = tlh.connect(testlink.TestlinkAPIClient)
+print tls.whatArgs('createTestPlan')
+createTestPlan(<testplanname>, <testprojectname>, [note=<note>], [active=<active>], [public=<public>], [devKey=<devKey>])
+ create a test plan 
+```
+
+or a description of all implemented API method could be generated
+
+```
+import testlink
+tlh = testlink.TestLinkHelper()
+tls = tlh.connect(testlink.TestlinkAPIClient)
+for m in testlink.testlinkargs._apiMethodsArgs.keys():
+	print tls.whatArgs(m), '\n'
+```
 
 TestLink-API-Python-client developers
 -------------------------------------
 *   [James Stock], [Olivier Renault]
-*   [g4l4drim], [pade], [lczub], [anton-matosov] 
+*   [g4l4drim], [pade], [lczub], [anton-matosov], [citizen-stig]
 *   anyone forgotten?
 
 
@@ -91,10 +143,12 @@ TestLink-API-Python-client developers
 [TestLink]: http://www.teamst.org/
 [Robot Framework]: http://code.google.com/p/robotframework
 [Jenkins]: http://jenkins-ci.org/
-[downloads]: https://github.com/lczub/TestLink-API-Python-client/downloads
+[Releases]: https://github.com/lczub/TestLink-API-Python-client/releases
+[Issues]: https://github.com/lczub/TestLink-API-Python-client/issues
 [Olivier Renault]: https://github.com/orenault/TestLink-API-Python-client
 [pade]: https://github.com/pade/TestLink-API-Python-client
 [g4l4drim]: https://github.com/g4l4drim/TestLink-API-Python-client
 [James Stock]: https://code.google.com/p/testlink-api-python-client/
 [lczub]: https://github.com/lczub/TestLink-API-Python-client
-[anton-matosov]: https://github.com/anton-matosov/TestLink-API-Python-client.git
+[anton-matosov]: https://github.com/anton-matosov/TestLink-API-Python-client
+[citizen-stig]: https://github.com/citizen-stig/TestLink-API-Python-client