Interim commit - a dummy file in the examples folder to act as a

placeholder. Doc generation tweaks.

diff --git a/doc/build.xml b/doc/build.xml
index 74cb272..c67a1dc 100644 (file)
--- a/doc/build.xml
+++ b/doc/build.xml
@@ -14,6 +14,7 @@
                                    <arg value="--name"/>\r
                                <arg value="JenkinsAPI"/>\r
                                    <arg value="--config=epydoc.cfg"/>\r
+                                   <arg value="--debug"/>\r
                                        <arg value="-v"/>\r
                </exec>\r
        </target>\r

diff --git a/examples/fetch_artifact.py b/examples/fetch_artifact.py
new file mode 100644 (file)
index 0000000..e69de29

diff --git a/jenkinsapi/__init__.py b/jenkinsapi/__init__.py
index e69de29..cc92d15 100644 (file)
--- a/jenkinsapi/__init__.py
+++ b/jenkinsapi/__init__.py
@@ -0,0 +1,43 @@
+"""\r
+About this library\r
+==================\r
+\r
+Jenkins is the market leading continuous integration system, originally created by Kohsuke Kawaguchi. This API makes Jenkins even easier to use by providing an easy to use conventional python interface.\r
+\r
+Jenkins (and It's predecessor Hudson) are fantastic projects - but they are somewhat Java-centric. Thankfully the designers have provided an excellent and complete REST interface. This library wraps up that interface as more conventional python objects in order to make most Jenkins oriented tasks simpler.\r
+\r
+This library can help you:\r
+\r
+ * Query the test-results of a completed build\r
+ * Get a objects representing the latest builds of a job\r
+ * Search for artefacts by simple criteria\r
+ * Block until jobs are complete\r
+ * Install artefacts to custom-specified directory structures\r
+ * username/password auth support for jenkins instances with auth turned on\r
+ * Ability to search for builds by subversion revision\r
+ * Ability to add/remove/query jenkins slaves\r
+\r
+Installing JenkinsAPI\r
+=====================\r
+\r
+Egg-files for this project are hosted on PyPi. Most Python users should be able to use pip or distribute to automatically install this project.\r
+\r
+Most users can do the following:\r
+\r
+easy_install jenkinsapi\r
+\r
+If you'd like to install in multi-version mode:\r
+\r
+easy_install -m jenkinsapi\r
+\r
+Project Authors\r
+===============\r
+\r
+ * Salim Fadhley (sal@stodge.org) \r
+ * Ramon van Alteren (ramon@vanalteren.nl) \r
+ * Ruslan Lutsenko (ruslan.lutcenko@gmail.com) \r
+\r
+Current code lives on github: https://github.com/salimfadhley/jenkinsapi\r
+\r
+"""\r
+__docformat__ = "epytext"
\ No newline at end of file