changeset 22:3b7f4104cd72

add README + release
author Jeff Hammel <jhammel@mozilla.com>
date Thu, 09 Dec 2010 15:33:27 -0800
parents e04729acf5be
children 2eaf17cb07f6
files README.txt setup.py
diffstat 2 files changed, 35 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Thu Dec 09 15:33:27 2010 -0800
@@ -0,0 +1,24 @@
+bzconsole
+=========
+
+bzconsole is a simple python API to bugzilla's bzapi.  
+Currently, it only has a few functions, including getting the
+configuration, listing the products and components, and filing a new
+bug.  I mostly introduced it to make filing bugs from the command line
+simple. I'll probably include more features going forward as I need
+them, but if anyone else is interested I'm happy to take feature
+requests.  
+
+Usage
+-----
+
+The console entry point is ``bz``.  Invoking without options gives you
+the usage and help.  The general pattern is 
+``bz [options] <command> [command-options]`` . Using ``bz help <command>`` 
+displays the help for the command.
+
+You can have a ~/.bz dotfile to contain your username and password in.
+
+Feel free to contact me with any questions!
+
+jhammel@mozilla.com
--- a/setup.py	Thu Dec 09 15:25:00 2010 -0800
+++ b/setup.py	Thu Dec 09 15:33:27 2010 -0800
@@ -3,22 +3,29 @@
 
 version = '0.1'
 
+readme = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'README.txt')
+
+if os.path.exists(readme):
+  description = file(readme).read()
+else:
+  description = ''
+
 setup(name='bzconsole',
       version=version,
       description='console API to bugzilla',
-      long_description="""\
-""",
+      long_description=description,
       classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='',
       author='Jeff Hammel',
       author_email='jhammel@mozilla.com',
-      url='http://k0s.org/mozilla/',
-      license='',
+      url='http://k0s.org/mozilla/hg/bzconsole',
+      license='MPL',
       packages=find_packages(exclude=['ez_setup', 'examples', 'tests']),
       include_package_data=True,
       zip_safe=False,
       install_requires=[
           # -*- Extra requirements: -*-
+        'simplejson'
       ],
       entry_points="""
       # -*- Entry points: -*-