620987 - setuptools-ify tools

Status: RESOLVED FIXED

(Release Engineering :: General, defect)

Description

[Dustin J. Mitchell [:dustin] (he/him)]

I'd like to add some extra utilities to tools, and the easiest way to do that is to install into a virtualenv using setuptools.

This will let us install shell scripts, too.  Hopefully tools can become the releng swiss army knife.

Comment 1

[Dustin J. Mitchell [:dustin] (he/him)]

Attachment: m620987-tools-r1.patch

This adds a setup.py that can install the modules under lib/python into a virtualenv.  If you want to edit them:

  cd tools/
  virtualenv --distribute sandbox
  . sandbox/bin/activate
  pip install -e.
  python
  >>> import util.hg

Note that you can also test it with
  python setup.py test
although at the moment a few tests fail for me (hg problems, not Python problems)

I'd like to put new functionality under the 'buildtools' package, but I don't see a huge reason to move the existing build, release, test, and util packages there.

Comment 2

[Aki Sasaki (not active)]

Comment on attachment 499330 [details] [diff] [review]
m620987-tools-r1.patch

*stamp*

Comment 3

[Aki Sasaki (not active)]

with a comment that chmoding it and making it #!able might be nice.

Comment 4

[Dustin J. Mitchell [:dustin] (he/him)]

Landed in a1e1ad0610bd, with a #! line and chmod +x

Comment 5

[[e-mail] (:bhearsum)]

It's not a big deal, but I'm curious why the 'test' module was moved, can you explain?

Comment 6

[Dustin J. Mitchell [:dustin] (he/him)]

Because otherwise you're making a toplevel package named 'test', which conflicts with the standard library's package of the same name.  Ideally, everything would end up under the 'buildtools' package, but we can work on that slowly.  Moving tests should have minimal impact.

Comment 7

[[e-mail] (:bhearsum)]

aaah ok, thanks for the explanation!