Merge lp:~statik/hydrazine/add-setup into lp:hydrazine

[Elliot Murphy]

This adds a setup.py for generating source tarball releases to enable packaging for Ubuntu.
It also adds some notes about how to do releases to make it easy for weary release managers to DTRT.

[John A Meinel (jameinel)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Elliot Murphy wrote:
> Elliot Murphy has proposed merging lp:~statik/hydrazine/add-setup into lp:hydrazine.
>
> Requested reviews:
> hydrazine-core (hydrazine-core)
>
>
> This adds a setup.py for generating source tarball releases to enable packaging for Ubuntu.
> It also adds some notes about how to do releases to make it easy for weary release managers to DTRT.
>

Just a comment. I think it would be better to put __version__ into
hydrazine/__init__.py and then update it from there. And in setup you
can do:

  import hydrazine
  ...
    version=hydrazine.__version__,

That way you get the version in the python runtime as well, and they
stay in sync. Also note that a fairly common design is to use:

 version_info = (0, 1, 0, 'dev', 0) # 5-tuple version using integers
 __version__ = '.'.join(map(str, version_info))

bzr uses a slightly more complex tuple => string conversion, but the
tuple can be useful for not needing to parse a semi-arbitrary string.

John
=:->

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkw08lgACgkQJdeBCYSNAAMGXgCggdi3yWZWW9D1E4lyfai4YUXf
kDIAoNHW+qjECkGEy35MlJcZz3QyEFl+
=UAIu
-----END PGP SIGNATURE-----

[Elliot Murphy (statik)]

I especially appreciate that you included sample code in your review, that makes it much easier to get my head around. However, this seems like YAGNI to me. I added the setup.py because it was the shortest path to a functioning and correct ubuntu package. Exposing a 5-tuple version number to python code is not needed by any of the current code or the packaging. Of course, I'm just driving by here, so maybe exposing rich API versioning is perfectly in line with the goals for hydrazine, but I'd prefer not to include it in this branch, and wait until some code actually needs to check versions and make decisions based on them.

[Martin Pool (mbp)]

Thanks very much Elliot, I've drafted you in to <https://edge.launchpad.net/~hydrazine-core> so if you like you can create a PPA there and upload the package. You can also land this yourself.

We should probably put the packaging into a separate branch rather than turning this into a native package.

I think John has a point that it's useful for the binaries to be able to answer 'lp-attach --version', even if you don't expect to do API versioning. But this is certainly a step forward and we could add that later.

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2010-02-14 23:12:51 +0000
+++ .bzrignore	2010-07-07 20:34:40 +0000
@@ -1,2 +1,4 @@
 .*.swp
 tmp.diff
+MANIFEST
+dist
 
=== added file 'HACKING'
--- HACKING	1970-01-01 00:00:00 +0000
+++ HACKING	2010-07-07 20:34:40 +0000
@@ -0,0 +1,11 @@
+HOWTO do a source tarball release:
+
+ * edit setup.py and increment the version number
+ * 'python setup.py sdist'
+ * look at the contents of the tarball created in dist/ and think a spell
+ * sign the tarball using a command like:
+     gpg -a --detach-sign hydrazine-0.2.tar.gz
+     this should create a file like hydrazine-0.2.tar.gz.asc
+ * Upload the new release to launchpad with a command like:
+     lp-upload-project hydrazine 0.2 hydrazine-0.2.tar.gz
+ * Announce the release, ping someone to build updated packages for the PPA
 
=== modified file 'TODO'
--- TODO	2010-02-15 01:00:35 +0000
+++ TODO	2010-07-07 20:34:40 +0000
@@ -16,3 +16,5 @@
 set tags, either incrementally or entirely
 
 show dates on bug
+
+finish writing man pages for each tool included in the ubuntu package. for extra credit make the man page content and the help text printed by each tool DRY.
 
=== added file 'setup.py'
--- setup.py	1970-01-01 00:00:00 +0000
+++ setup.py	2010-07-07 20:34:40 +0000
@@ -0,0 +1,29 @@
+#!/usr/bin/python
+
+from distutils.core import setup
+from os.path import join, dirname
+
+description = file(join(dirname(__file__), 'README'), 'rb').read()
+
+setup(
+    name='hydrazine',
+    version='0.1',
+    url='https://launchpad.net/hydrazine',
+    author='Martin Pool',
+    author_email='[e-mail]',
+    license='GPLv3',
+    description='A dern fine collection of CLI tools for Launchpad.',
+    long_description=description,
+    py_modules=[],
+    packages=['hydrazine'],
+    scripts=['bugclient', 'check-membership', 'scan-merge-proposals',
+        'capture-bug-counts', 'feed-pqm', 'lp-attach'],
+    classifiers = [
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: GNU General Public License v3 (GPL3)',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Topic :: Software Development',
+    ],
+    )