/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/plugins/launchpad/account.py

  • Committer: mernst at mit
  • Date: 2008-10-16 10:57:16 UTC
  • mto: This revision was merged to the branch mainline in revision 3799.
  • Revision ID: mernst@csail.mit.edu-20081016105716-v8x8n5t2pf7f6uds
Improved documentation of stacked and lightweight branches

These patches improve the User Guide's documentation of stacked and
lightweight branches.

Section "1.2.6 Putting the concepts together" should mention stacked
branches and the difference between them and lightweight branches.  It
should also contain links to further details of the common scenarios.

Section "5.3.4 Getting a lightweight checkout" should mention stacked
branches as an option, and should link to all the options, not just some of
them.  It should also clarify that lightweight only applies to checkouts,
not to arbitrary branches.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/account.py
 
1
# Copyright (C) 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""Functions to manage the user's Launchpad user ID.
 
18
 
 
19
This allows the user to configure their Launchpad user ID once, rather
 
20
than once for each place that needs to take it into account.
 
21
"""
 
22
 
 
23
from bzrlib import errors
 
24
from bzrlib.config import GlobalConfig
 
25
from bzrlib.transport import get_transport
 
26
 
 
27
 
 
28
LAUNCHPAD_BASE = 'https://launchpad.net/'
 
29
 
 
30
 
 
31
class UnknownLaunchpadUsername(errors.BzrError):
 
32
    _fmt = "The user name %(user)s is not registered on Launchpad."
 
33
 
 
34
 
 
35
class NoRegisteredSSHKeys(errors.BzrError):
 
36
    _fmt = "The user %(user)s has not registered any SSH keys with Launchpad."
 
37
 
 
38
 
 
39
def get_lp_login(_config=None):
 
40
    """Return the user's Launchpad username"""
 
41
    if _config is None:
 
42
        _config = GlobalConfig()
 
43
 
 
44
    return _config.get_user_option('launchpad_username')
 
45
 
 
46
 
 
47
def set_lp_login(username, _config=None):
 
48
    """Set the user's Launchpad username"""
 
49
    if _config is None:
 
50
        _config = GlobalConfig()
 
51
 
 
52
    _config.set_user_option('launchpad_username', username)
 
53
 
 
54
 
 
55
def check_lp_login(username, _transport=None):
 
56
    """Check whether the given Launchpad username is okay.
 
57
 
 
58
    This will check for both existence and whether the user has
 
59
    uploaded SSH keys.
 
60
    """
 
61
    if _transport is None:
 
62
        _transport = get_transport(LAUNCHPAD_BASE)
 
63
 
 
64
    try:
 
65
        data = _transport.get_bytes('~%s/+sshkeys' % username)
 
66
    except errors.NoSuchFile:
 
67
        raise UnknownLaunchpadUsername(user=username)
 
68
 
 
69
    if not data:
 
70
        raise NoRegisteredSSHKeys(user=username)