Merge lp:~lifeless/lptools/lp-project into lp:~dobey/lptools/trunk

[Robert Collins]

If its not obvious, call me names.

[Robert Collins (lifeless)]

Ok, so now it needs an explanation. I've refactored the minimal command support stuff to permit it to be reused via convention in other front-end scripts.

[lp:~lifeless/lptools/lp-project]

13. By Robert Collins on 2010-03-11

Refactor CLI support to permit multiple front ends.

14. By Robert Collins on 2010-03-11

Cleanups.

15. By Robert Collins on 2010-03-11

Finish making the new command module work generically.

16. By Robert Collins on 2010-03-11

Bah, missed imports when migrating.

17. By Robert Collins on 2010-03-11

Add lp-project CLI script, which can create a project in launchpad.

[Robert Collins (lifeless)]

Final tweaks done - lp-project now exists, and 'lp-project create foo' will create a foo project, management team, mailing list and trunk branch in a fairly sensible layout.

[Jelmer Vernooij (jelmer)]

This seems reasonable overall. It will have to be updated to not use edge, which has been deprecated.

review: Needs Fixing (code)

[Robert Collins (lifeless)]

I won't be able to do this for some time; care to tweak-as-landing ?

[Jelmer Vernooij (jelmer)]

On 26/08/11 01:28, Robert Collins wrote:
> I won't be able to do this for some time; care to tweak-as-landing ?
Sure, happy to.

Cheers,

Jelmer

[Jelmer Vernooij (jelmer)]

This is now merged into lp:lptools; it won't show up here though, as this branch was originally proposed against Dobey's lptools trunk rather than the team one.

=== added file 'MANUAL.txt'
--- MANUAL.txt	1970-01-01 00:00:00 +0000
+++ MANUAL.txt	2010-03-11 11:42:24 +0000
@@ -0,0 +1,12 @@
+=======
+LPTools
+=======
+
+Environment Variables
+---------------------
+
+When running lptools, the variable LAUNCHPAD_API can be set to cause a specific
+Launchpad service to be connected to. Current values are:
+
+* edge
+* staging

=== modified file 'bin/lp-milestones'
--- bin/lp-milestones	2010-02-20 06:48:17 +0000
+++ bin/lp-milestones	2010-03-11 11:42:24 +0000
@@ -16,42 +16,19 @@
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from __future__ import with_statement
+"""lp-milestones -- An lptools command to work with milestones in launchpad.
+https://launchpad.net/lptools/
+
+lp-milestones help commands -- list commands
+"""
+
 import time
-import optparse
-import os
-import sys
 
 # Might want to make errors import lazy.
-from bzrlib import commands, errors, ui, version_info as bzr_version_info
+from bzrlib import errors
 from launchpadlib.errors import HTTPError
 
-from lptools import config
-
-def list_commands(command_names):
-    mod = sys.modules[__name__]
-    command_names.update(commands._scan_module_for_commands(mod))
-    return command_names
-
-
-def get_command(cmd_or_None, cmd_name):
-    if cmd_name is None:
-        return cmd_help()
-    try:
-        return globals()['cmd_' + cmd_name]()
-    except KeyError:
-        return cmd_or_None
-
-
-class LaunchpadCommand(commands.Command):
-    """Base class for commands working with launchpad."""
-
-    def run_argv_aliases(self, argv, alias_argv=None):
-        # This might not be unique-enough for a cachedir; can do
-        # lp-milestones/cmdname if needed.
-        self.launchpad = config.get_launchpad('lp-milestones')
-        return commands.Command.run_argv_aliases(self, argv, alias_argv)
-
+from lptools.command import *
 
 class cmd_create(LaunchpadCommand):
     """Create a milestone.
@@ -108,25 +85,6 @@
                 raise
 
 
-class cmd_help(commands.Command):
-    """Show help on a command or other topic."""
-
-    # Can't use the stock bzrlib help, because the help indices aren't quite
-    # generic enough.
-    takes_args = ['topic?']
-    def run(self, topic=None):
-        if topic is None:
-            self.outf.write(
-"""lp-milestones -- An lptools command to work with milestones in launchpad.
-https://launchpad.net/lptools/
-
-lp-milestones help commands -- list commands
-""")
-        else:
-            import bzrlib.help
-            bzrlib.help.help(topic)
-
-
 class cmd_release(LaunchpadCommand):
     """Create a release from a milestone.
     
@@ -168,22 +126,5 @@
         m.lp_save()
 
 
-def do_run_bzr(argv):
-    if bzr_version_info > (2, 2, 0):
-        # in bzr 2.2 we can disable bzr plugins so bzr commands don't show
-        # up.
-        return commands.run_bzr(argv, lambda:None, lambda:None)
-    else:
-        return commands.run_bzr(argv)
-
-
-def main():
-    commands.Command.hooks.install_named_hook('list_commands', list_commands,
-        "list")
-    commands.Command.hooks.install_named_hook('get_command', get_command,
-        "get")
-    ui.ui_factory = ui.make_ui_for_terminal(sys.stdin, sys.stdout, sys.stderr)
-    sys.exit(commands.exception_to_return_code(do_run_bzr, sys.argv[1:]))
-
 if __name__ == "__main__":
     main()

=== added file 'bin/lp-project'
--- bin/lp-project	1970-01-01 00:00:00 +0000
+++ bin/lp-project	2010-03-11 11:42:24 +0000
@@ -0,0 +1,119 @@
+#!/usr/bin/python
+#
+# Author: Robert Collins <[e-mail]>
+#
+# Copyright 2010 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""lp-project -- An lptools command to work with projects in Launchpad.
+https://launchpad.net/lptools/
+
+lp-project help commands -- list commands
+"""
+
+import time
+import os
+import sys
+
+# Might want to make errors import lazy.
+from bzrlib import bzrdir, directory_service, errors, transport
+from launchpadlib.errors import HTTPError
+
+from lptools.command import *
+
+class cmd_create(LaunchpadCommand):
+    """Create a project.
+
+    This creates two teams - a management/committer team owner by you and
+    a -dev mailing list owned by the mgmt team. It then creates the project,
+    makes it owned by the committer team, creates a new empty bzr branch for
+    trunk and then fires up a web browser pointing at the project for you to
+    fine tune.
+
+    After running this command you need to:
+     - set what LP features you are using
+       (https://bugs.edge.launchpad.net/launchpad/+bug/537269)
+     - describe your project (title, summary, description)
+     - upload your code to lp:PROJECT
+     - turn on the mailing list by hand
+       (https://bugs.edge.launchpad.net/launchpad/+bug/537258)
+    
+    lp-project create projectname
+    """
+
+    takes_args = ['project']
+
+    def run(self, project):
+        self.outf.write('creating project %s\n' % project)
+        #load the lp plugin - we needs it, but don't want its commands shown.
+        from bzrlib.plugins import launchpad
+        project_d = {'project':project}
+        mgmt = self.launchpad.people.newTeam(
+            display_name='%s committers' % project, name=project,
+            subscription_policy='Moderated Team', team_description="This is the"
+            " %(project)s project maintainers and committers team. Membership "
+            "in this team grants commit access to the %(project)s trunk and "
+            "release branches, and owner access to the project. To become a "
+            "member of this team, please contact the project via the "
+            "%(project)s-dev mailing list." % {'project':project})
+        dev = self.launchpad.people.newTeam(
+            display_name='%s mailing list' % project, name='%s-dev' % project,
+            subscription_policy='Open Team', team_description="This is the"
+            " %(project)s (https://launchpad.net/%(project)s) development "
+            "discussion mailing list. To subscribe to the list join this team "
+            "(it does not receive bug mail or other such dross)." % project_d)
+	dev.team_owner = mgmt
+	dev.lp_save()
+        proj = self.launchpad.projects.new_project(
+            display_name=project,
+            name=project,
+            registrant=mgmt,
+            title="Put what you want to show in browser window titles for %s "
+                "here" % project,
+            description="""Put a long description of the %(project)s project here.
+
+A mailing list for discussion, usage and development is at https://launchpad.net/~%(project)s-dev - all are welcome to join. Some folk hang out on #%(project)s on irc.freenode.net.
+""" % project_d,
+            home_page_url="https://launchpad.net/%s" % project,
+            summary="Put a pithy summary of %s here." % project,
+            )
+        proj.bug_reporting_guidelines = """Enough data to reproduce the behaviour if possible.
+
+If that is not possible, just describe as well as you can what is happening and we will talk through the issue with you.
+"""
+        proj.owner = mgmt
+        proj.lp_save()
+        branch_path = '~%(project)s/%(project)s/trunk' % project_d
+        lp_host = os.environ.get('LAUNCHPAD_API', '')
+        if lp_host:
+            lp_host = '//%s/' % lp_host
+        branch = bzrdir.BzrDir.create_branch_convenience(
+            'lp:%s%s' % (lp_host, branch_path), force_new_tree=False)
+        series = proj.getSeries(name='trunk')
+        series.branch_link = self.launchpad.load(branch_path)
+        series.lp_save()
+        self.outf.write("""
+Project created at %s (sorry about the url. (https://bugs.edge.launchpad.net/launchpadlib/+bug/316694)).
+You now need to:
+ - set what LP features you are using
+   (https://bugs.edge.launchpad.net/launchpad/+bug/537269)
+ - describe your project (title, summary, description)
+ - upload your code to lp:PROJECT
+ - turn on the mailing list by hand
+   (https://bugs.edge.launchpad.net/launchpad/+bug/537258)
+""" % proj.self_link)
+
+
+if __name__ == "__main__":
+    main()

=== added file 'lptools/command.py'
--- lptools/command.py	1970-01-01 00:00:00 +0000
+++ lptools/command.py	2010-03-11 11:42:24 +0000
@@ -0,0 +1,101 @@
+# Author: Robert Collins <[e-mail]>
+#
+# Copyright 2010 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Command abstraction for the CLI parts of lptools.
+
+To use:
+
+* in your front end script define a docstring - this is used for global help.
+
+* from this module import *
+
+* derive commands from LaunchpadCommand and call them cmd_NAME.
+
+* At the bottom of your script, do::
+
+  if __name__ == '__main__':
+      main()
+"""
+
+__all__ = [
+    'LaunchpadCommand',
+    'main',
+    ]
+
+import os
+import sys
+
+from bzrlib import commands, ui, version_info as bzr_version_info
+
+from lptools import config
+
+def list_commands(command_names):
+    mod = sys.modules['__main__']
+    command_names.update(commands._scan_module_for_commands(mod))
+    return command_names
+
+
+def get_command(cmd_or_None, cmd_name):
+    if cmd_name is None:
+        return cmd_help()
+    elif cmd_name == 'help':
+        return cmd_help()
+    klass = getattr(sys.modules['__main__'], 'cmd_' + cmd_name, None)
+    if klass is not None:
+        return klass()
+    return cmd_or_None
+
+
+class LaunchpadCommand(commands.Command):
+    """Base class for commands working with launchpad."""
+
+    def run_argv_aliases(self, argv, alias_argv=None):
+        # This might not be unique-enough for a cachedir; can do
+        # $frontend/cmdname if needed.
+        self.launchpad = config.get_launchpad(os.path.basename(sys.argv[0]))
+        return commands.Command.run_argv_aliases(self, argv, alias_argv)
+
+
+class cmd_help(commands.Command):
+    """Show help on a command or other topic."""
+
+    # Can't use the stock bzrlib help, because the help indices aren't quite
+    # generic enough.
+    takes_args = ['topic?']
+    def run(self, topic=None):
+        if topic is None:
+            self.outf.write(sys.modules['__main__'].__doc__)
+        else:
+            import bzrlib.help
+            bzrlib.help.help(topic)
+
+
+def do_run_bzr(argv):
+    if bzr_version_info > (2, 2, 0):
+        # in bzr 2.2 we can disable bzr plugins so bzr commands don't show
+        # up.
+        return commands.run_bzr(argv, lambda:None, lambda:None)
+    else:
+        return commands.run_bzr(argv)
+
+
+def main():
+    commands.Command.hooks.install_named_hook('list_commands', list_commands,
+        "list")
+    commands.Command.hooks.install_named_hook('get_command', get_command,
+        "get")
+    ui.ui_factory = ui.make_ui_for_terminal(sys.stdin, sys.stdout, sys.stderr)
+    sys.exit(commands.exception_to_return_code(do_run_bzr, sys.argv[1:]))

=== modified file 'lptools/config.py'
--- lptools/config.py	2010-02-20 04:46:06 +0000
+++ lptools/config.py	2010-03-11 11:42:24 +0000
@@ -55,10 +55,10 @@
         creds = Credentials()
         with file(credspath) as f:
             creds.load(f)
-        return launchpad.Launchpad(creds, EDGE_SERVICE_ROOT, cachedir)
+        return launchpad.Launchpad(creds, _service_root(), cachedir)
     else:
         result = launchpad.Launchpad.get_token_and_login('lptools',
-            EDGE_SERVICE_ROOT, cachedir)
+            _service_root(), cachedir)
         with file(credspath, "w") as f:
             result.credentials.save(f)
         return result
@@ -81,3 +81,12 @@
     cachedir = lptools_cachedir()
     ensure_dir(cachedir)
     return os.path.join(lptools_cachedir(), 'credentials')
+
+
+def _service_root():
+    """Get the service root to connect to.
+
+    By default this is EDGE_SERVICE_ROOT. If LAUNCHPAD_API is set in the
+    environment, that value is used instead.
+    """
+    return os.environ.get('LAUNCHPAD_API', EDGE_SERVICE_ROOT)