← Back to branch summary

~launchpad-pqm/launchpad/devel

« back to all changes in this revision

Viewing changes to lib/lp/app/tour/api

  • Committer: William Grant
  • Date: 2011-12-30 09:48:38 UTC
  • mto: This revision was merged to the branch mainline in revision 14612.
  • Revision ID: william.grant@canonical.com-20111230094838-cspfdldos3ap5cho
Hang canonical's ZCML off lp.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/lp/app/tour/api
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
 
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3
 
<head>
4
 
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
5
 
    <meta content="The Launchpad API and Python library (launchpadlib) give you direct access to your data in Launchpad." name="description"/>
6
 
    <meta content="canonical, launchpad, tour" name="keywords"/>
7
 
    <meta content="en-US" name="language"/>
8
 
    <title>Launchpad tour</title>
9
 
    <style media="all" type="text/css">
10
 
        @import "launchpad-tour.css";
11
 
    </style>
12
 
    <script type="text/javascript" src="jquery-1.2.6.pack.js"></script>
13
 
    <script type="text/javascript" src="launchpad-tour.js"></script>
14
 
    <script type="text/javascript" src="selector.js"></script>
15
 
</head>
16
 
<body>
17
 
    <div id="container">
18
 
        <p class="page-number">8 of 11</p>
19
 
        <ul id="navigation-drop-down">
20
 
            <li class="button-next"><a id="btnNext" href="feature-tracking" tabindex="1" accesskey="1" title="Read about spec tracking in Launchpad">Next</a></li>
21
 
            <li class="home"><a href="index" accesskey="2">Launchpad tour home</a></li>
22
 
            <li><a href="bugs" accesskey="3">Cross-project bug tracking</a></li>
23
 
            <li><a href="branch-hosting-tracking" accesskey="4">Code hosting and review</a></li>
24
 
            <li><a href="translation" accesskey="5">Web-based translation</a></li>
25
 
            <li><a href="community" accesskey="6">Mailing lists and teams</a></li>
26
 
            <li><a href="ppa" accesskey="7">Software distribution</a></li>
27
 
            <li><a href="community-support" accesskey="8">Community support</a></li>
28
 
            <li class="current"><a href="api" accesskey="9">Beta: web services API</a></li>
29
 
            <li><a href="feature-tracking" accesskey="a">Lightweight specifications</a></li>
30
 
            <li><a href="release-management" accesskey="b">Release management</a></li>
31
 
            <li><a href="join-launchpad" accesskey="c">Join Launchpad!</a></li>
32
 
        </ul>
33
 
        <div id="page-intro-top"></div>
34
 
        <div id="page-intro">
35
 
            <h1>API and Python library</h1>
36
 
            <p>
37
 
                <img src="images/api/main-image.jpg" alt="A mock-up of Python code using launchpadlib" />
38
 
            </p>
39
 
            <p class="intro-text">
40
 
                <strong>Create your own applications that work directly with Launchpad.</strong> Join the beta of our RESTful web services API.
41
 
 
42
 
<br /><br />
43
 
We've even done the hard work for you: use our LGPL Python library &mdash; <a href="https://help.launchpad.net/API/launchpadlib/">launchpadlib</a> &mdash; to manipulate data in Launchpad just like any other Python object.
44
 
            </p>
45
 
            <div id="link-holder"><a href="https://help.launchpad.net/API">Get started with the Launchpad API &gt;</a></div>
46
 
        </div>
47
 
        <div id="page-intro-bottom"></div>
48
 
        <ul id="secondary-navigation">
49
 
            <li class="button-prev">
50
 
                <a href="community-support" title="Back to the user support tracking page" accesskey="d" tabindex="2">Back</a>
51
 
            </li>
52
 
            <li class="button-next">
53
 
                <a href="feature-tracking" accesskey="e" tabindex="3" title="Read about spec tracking in Launchpad">Next</a>
54
 
            </li>
55
 
        </ul>
56
 
        <div id="further-information">
57
 
            <div class="furthur-information-block">
58
 
                <div class="furthur-information-block-top"></div>
59
 
                <div class="furthur-information-block-mid">
60
 
                    <div class="block">
61
 
                        <h3>What's available</h3>
62
 
                        <h4>The Launchpad API frees your data and makes it easy to mould Launchpad to your workflow. </h4>
63
 
                        <p class="screen-holder">
64
 
                            <img src="images/api/1.png" alt="News about what's new in the API" />                        </p>
65
 
                        <p>
66
 
                            During the beta, we're exposing more and more of Launchpad through the API. Right now the API gives you access to:
67
 
 
68
 
                        </p>
69
 
                        <p>
70
 
                          <ul>
71
 
                            <li><strong>bugs:</strong> report, access and manage</li>
72
 
                            <li><strong>people, teams and projects:</strong> create, search and edit</li>
73
 
                            <li><strong>code</strong>: access branch information.</li>
74
 
                          </ul>
75
 
                        </p>
76
 
 
77
 
                        <p>We're adding more every month. See the Launchpad <a href="http://news.launchpad.net/category/api">blog's API category</a> for regular updates.</p>
78
 
 
79
 
 
80
 
 
81
 
                        </ul>
82
 
                    </div>
83
 
                    <div class="block odd">
84
 
                    <h3>Python library </h3>
85
 
                        <h4>Using launchpadlib you can treat Launchpad data like any other Python object.</h4>
86
 
                        <p class="screen-holder">
87
 
                            <img src="images/api/3.png" alt="Using launchpadlib"  />                        </p>
88
 
                        <p>
89
 
                           If you're a Python developer, you can access and manipulate data in Launchpad as though it were any other Python object.<p>
90
 
 
91
 
                        <p><br />
92
 
                                <code>
93
 
                                people = launchpad.people<br />
94
 
                                salgado = people['salgado']<br />
95
 
                                print salgado.display_name<br />
96
 
                                # Guilherme Salgado<br />
97
 
                                </code>
98
 
                                <br />
99
 
                        </p>
100
 
 
101
 
                        <p>You can be up and running in minutes, without having to make any API calls directly. <a href="https://help.launchpad.net/API/launchpadlib">Read more about launchpadlib &gt;</a>.
102
 
                        </p>
103
 
                    </div>
104
 
                    <div class="clear"></div>
105
 
                </div>
106
 
                <div class="furthur-information-block-bot"></div>
107
 
            </div>
108
 
            <div class="furthur-information-block singular">
109
 
                <div class="furthur-information-block-top"></div>
110
 
                <div class="furthur-information-block-mid">
111
 
                    <div class="block">
112
 
                      <h3>Simple account authentication</h3>
113
 
                        <h4>
114
 
                        Your application's users log into their own Launchpad account.</h4>
115
 
                        <p class="screen-holder">
116
 
                            <img src="images/api/2.png" alt="The API's authentication page" />
117
 
                        </p>
118
 
                        <p>
119
 
                          Before the API will give your software access to Launchpad data, your user needs to log into their Launchpad account. Launchpad handles that for you, using <a href="http://oauth.net/">OAuth</a>, by opening an authentication page in your user's web browser. They can then choose what access to grant your software, from reading only public data through to full read-write access.</p>
120
 
                    </div>
121
 
                    <div class="clear"></div>
122
 
                <div class="furthur-information-block-bot"></div>
123
 
            </div>
124
 
        </div>
125
 
        </div>
126
 
        <ul id="footer-navigation">
127
 
            <li class="button-prev">
128
 
                <a href="community-support" title="Back to the user support tracking page" accesskey="f" tabindex="4">Back</a>
129
 
            </li>
130
 
            <li class="button-next" title="Read about spec tracking in Launchpad">
131
 
                <a href="feature-tracking" accesskey="g" tabindex="5">Next</a>
132
 
            </li>
133
 
             <li class="copyright">
134
 
                &copy; 2004-2012 Canonical Ltd. <a href="https://help.launchpad.net/Legal" accesskey="h" tabindex="6">Terms of Use</a> &#58; <a href="https://help.launchpad.net/Feedback" accesskey="i" tabindex="7">Feedback</a> &#58; <a href="https://answers.launchpad.net/launchpad-project/+faqs" accesskey="j" tabindex="8">FAQ</a>
135
 
            </li>
136
 
        </ul>
137
 
    </div>
138
 
</body>
139
 
</html>