Permalink
Browse files

basic documentation

  • Loading branch information...
sherold
sherold committed Aug 27, 2012
1 parent b96527a commit fb64422fd3f4ca55c8cfd4306b988aa5ebfd21f4
Showing with 23 additions and 2 deletions.
  1. +23 −2 README.md
View
@@ -1,4 +1,25 @@
-setuptools-teamcity-test
+Setuptools Command to Run Tests in a TeamCity-compatible Manner
========================
-Custom setuptools command to run tests in a TeamCity compatible manner
+If you use python setuptools (setup.py) and run your project in TeamCity, you want to be able to see
+which tests failed and which tests got executed. This code does exactly does.
+
+Usage
+-----
+
+Instead of running:
+
+ python setup.py test
+
+use:
+
+ python setup.py --command-packages teamcity_test teamcity_test
+
+which does exactly the same, but uses [TeamCity build script interaction](http://confluence.jetbrains.net/display/TCD7/Build+Script+Interaction+with+TeamCity)
+to communicate with the TeamCity build agent. This code is just an extension of the nice teamcity-messages module available under
+http://confluence.jetbrains.net/display/TW/Python+Unit+Test+Reporting
+
+Installation
+------------
+
+ python setup.py install

0 comments on commit fb64422

Please sign in to comment.