Project

General

Profile

History

Guide » Developer Guide » Rest api »

Rest api ẅith python » History » Revision 9

Revision 8 (Ian Epperson, 2013-02-07 20:46) → Revision 9/18 (Ian Epperson, 2013-02-07 20:50) 

h1. Using the REST API with Python 

 Here is the two well-known options for using REST API with python.  

  

  # "PyActiveResource":http://code.google.com/p/pyactiveresource/ 
  # "Python library":https://github.com/ianepperson/pyredminews 


 h2. *PyActiveResource* example: 

 <pre> 
 <code class="python"> 
 # "PyActiveResource":http://code.google.com/p/pyactiveresource/ 
 



 Importing pyactiveresource 
 from pyactiveresource.activeresource import ActiveResource 

 class Issue(ActiveResource): 
     _site = 'http://redmine.foo.org' 
     _user = 'username' 
     _password = 'password' 

 # Get issues 
 issues = Issue.find() 

 # Get a specific issue, from its id 
 issue = Issue.find(1345) 

 # Issue attributes 

 # Updating an attribute 

 </pre> 

 h2. *Python library* example: 

 Suppose Eric fell ill and was out for several days. You need to crawl through the project called Parrot and move any due date for issues assigned to Eric out by two more weeks. 

 The dateutil library contains a handy method called reativedelta for calculating relative dates. 

 <pre> 
 <code class="python"> 
 # Import the Redmine class 
 from redmine import Redmine 
 from dateutil.relativedelta import relativedelta 

 server = Redmine('http://my-server.com', username='Me', password='seakrit') 
 project = server.projects['parrot'] 

 # Find Eric in the user data 
 for u in server.users: 
     if u.firstname == 'Eric' and u.lastname == 'Idle': 
        user = u 
        break 
 else: 
     raise Exception("Didn't find Eric Idle in the user dateabase") 

 # Extend issues in project assigned to user by two weeks 
 for issue in project.issues(assigned_to_id=user.id): 
     if issue.due_date is not None: 
        issue.due_date += relativedelta(weeks=+2) 
        issue.save('Giving Eric more time to complete - he was out ill') 

 
 </pre> 

 h2. *PyActiveResource* example: 

 <pre> 
 # Importing pyactiveresource 
 from pyactiveresource.activeresource import ActiveResource 

 class Issue(ActiveResource): 
     _site = 'http://redmine.foo.org' 
     _user = 'username' 
     _password = 'password' 

 # Get issues 
 issues = Issue.find() 

 # Get a specific issue, from its id 
 issue = Issue.find(1345) 

 # Issue attributes 

 # Updating an attribute 

 </pre>