summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..6e3da9b
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+This is a python module that provides a nice, python-ish interface to Bugzilla
+over XMLRPC.
+
+Currently it targets Red Hat's xmlrpc services, because:
+a) That's what the Fedora project uses, and
+b) It's a lot richer than the Bugzilla 3.0 web services API.
+
+In the near future (see TODO) we will support the Bugzilla 3.0 API, although
+it may not support all the same methods as the RHBugzilla class.
+
+In the long-term future, Red Hat is planning on porting their interfaces to
+the Bugzilla 3.0 framework and contributing them to upstream Bugzilla, so in
+time we may drop the Red Hat implementation in favor of one unified Bugzilla
+interface. Won't that be nice?
+
+Comments, suggestions, and - most of all - patches are welcomed and encouraged.
+
+Enjoy.
+
+Will Woods <wwoods@redhat.com>, 7 Sep 2007