Working with Launchpad API !

Launchpad API
Dear Readers,


Since last few weeks I was working with launchpad-api in order to generate some statistical and analytical reports for OpenERP project, I found launchpad-api quite powerful and interesting but required improvement in terms of developer experience, during my several days of work I have worked with the branches, bugs and merge proposal object.

Here I would like to share some of the interesting examples with methods that I used to work in the production.

Working with launchpadlib

launchpadlib is an open-source Python library that lets you treat the HTTP resources published by Launchpad's web service as Python objects responding to a standard set of commands. With launchpadlib you can integrate your applications into Launchpad without knowing a lot about HTTP client programming.

Installation !

sudo apt-get install python-launchpadlib


Launchpad's web service currently exposes the following major parts of Launchpad:

  • People and teams
  • Team memberships
  • Bugs and bugtasks
  • The project registry
  • Hosted files, such as bug attachments and mugshots.

Anonymous access

The Launchpad.login_anonymously() method will give you automatic read-only access to public Launchpad data.

from launchpadlib.launchpad import Launchpad
launchpad = Launchpad.login_anonymously('just testing', 'production', cachedir)

Authenticated access

To get read-write access to Launchpad, or to see a user's private data, you'll need to get an OAuth credential for that user. If you're writing an application that the user will run on their own computer, this is easy: just call the Launchpad.login_with() method.

This method takes two important arguments: the name of your application, and the name of the Launchpad server you want to run against. The default server name is 'staging', so that you don't destroy data by accident while developing. When you do a release, you can change this to 'production'.

from launchpadlib.launchpad import Launchpad
launchpad = Launchpad.login_with('My Application', 'staging')

Authenticated access for website integration

Things are a little more difficult if you want to integrate Launchpad's functionality into your own website. You can't call Launchpad.login_with(), because that will open up a web browser on your webserver--not on your user's computer.

Instead, you create a Credentials object identifying your website and call get_request_token() to ask Launchpad for a request token. Be sure to pass in the name of the Launchpad server you want to use (probably "production" as web_root.

from launchpadlib.credentials import Credentials
credentials = Credentials("my website")
request_token_info = credentials.get_request_token(web_root="production")

You'll get back a string that looks like 'https://launchpad.net/+authorize-token?oauth_token=...' This is the URL your end-user needs to visit in order to authorize your token.

At this point, you should redirect your user to that URL. Then, start periodically calling exchange_request_token_for_access_token():

  from lazr.restfulclient.errors import HTTPError
  complete = False
  while not complete:
      try:
          credentials.exchange_request_token_for_access_token(
             web_root="production")
          complete = True
      except HTTPError:
          # The user hasn't authorized the token yet.

Once exchange_request_token_for_access_token() successfully executes, an authorized access token will be present in credentials.access_token. You can then pass the Credentials object into the Launchpad constructor.

Top Level objects

  • .bugs: All the bugs in Launchpad
  • .people: All the people in Launchpad
  • .me: You
  • .distributions: All the distributions in Launchpad
  • .projects: All the projects in Launchpad
  • .project_groups: All the project groups in Launchpad

Accessing project's branches

project = launchpad.projects['openobject-addons']
branches = project.getBranches(status = ['Experimental', 'Development', 'Mature', 'Merged', 'Abandoned'])
for branch in branches:
    #Iteration over the branch list and access branch data

Refer Launchpad API documentation to understand what you can assess with reference of branch.

Accessing project's merge proposals

project = launchpad.projects['openobject-addons']
proposals = project.getMergeProposals(status=['Work in progress', 'Approved', 'Needs review', 'Rejected', 'Merged', 'Code failed to merge', 'Queued', 'Superseded'])
for merge in proposals:
    #Iteration over the proposals and branch merge data

Refer Launchpad API documentation to understand what you can assess with branch merge proposal.

Accessing project's bugs 

project = launchpad.projects['openobject-addons']
bugs = project.searchTasks(status = ['New', 'Incomplete', 'Triaged', 'Opinion', 'Invalid', 'Won\'t Fix', 'Confirmed', 'In Progress', 'Fix Committed', 'Fix Released'])
for bug in bugs:
    #Iteration over the bugs and bug data

Refer Launchpad API documentation to understand what you can assess with bug object.

Launchpad Analytic in OpenERP

I made an synchronization of branches, merge proposals, branches and user related to each information  in OpenERP that generate lots of statistical information that gives me an view of openobject and related projects and its activities.

Month wise branches merged in each project

Merged proposals accepted in trunk by category

Popular posts from this blog

Server Action - Improvements

Hello to All, I am happy to Post this that we have revised the server action which is the interesting feature for the new version OpenEPR 5. We change the few configuration for the quick and easy configuration for some important functionalities. like Create Object, Write Object, Send Email, and the excellent is Multi Action to allows to execute the multiple server actions at the same time. Test it your self, get the new revised document that will helps you to configure the all the server action your self.
Read more

Implement OpenERP for Service company

Image
Team of Professionals Are you working for or running a professional service, like charted accounting, support center, annual maintenance / service contracts, etc. where you have to keep concentrate on your customer communication and service level, to make them satisfy and up to date with the real time updated information. OpenERP is ready to helps you in that case, the generic way of managing customer communications, keep track of projects, tasks and time management, Billing based on the tasks or projects or time spend which is base of any professional services, All this will give you a full control on your professional services. Some Problems Here are some questions which I would like to ask, before you look in to details of OpenERP, If any of the questions is a real problem for you, OpenERP is ready to help you with its open source business model which will offer you solution at comparatively very low cost. Are you professional service provider and you...
Read more

I am on a trip with Friends !!

Image
Hello ! I am very happy, because after long time, I am again going for a small but exiting trip with my friends. we have visited  Pune , Khandala , Pinchgini , Lonavala , and Mahabaleshwar  in my last trip, This time we are going to visit again some missing places of last trip near from pune and this is the best season to visit this place is monsoon. Tourist can experience the scenic view of waterfalls. Matheran Ghat Matheran is located about 100 km from Mumbai, 120 km from Pune. and 320 km from Surat. It lies on the busy Mumbai-Pune rail link and the nearest train station is at Neral, approximately 11 km from Matheran. From Neral, one can either rent a taxi (50 rupees for a shared cab, 250 for the whole car) to the entrance of Matheran. From the taxi stop at Matheran, one can walk to the city center or rent a horse (150-200 rupees per horse). Lavasa - India's first planned hill station city Lavasa is located in the Western Ghats, on t...
Read more