Skip to content

netmarkjp/pybacklog

Repository files navigation

pybacklog

Backlog API v2 Client Library for Python

Build Status

Requirements

  • Python 2.7 or Python 3.5+
  • requests 2.x

Install

pip install pybacklog 

Usage

from pybacklog import BacklogClient client = BacklogClient("your_space_name", "your_api_key") # space space = client.do("GET", "space") # GET /api/v2/space print(space.get(u"spaceKey")) # project projects = client.projects() # activity activities = client.project_activities("YOUR_PROJECT", {"activityTypeId[]": [1, 2]}) # list issue project_id = client.get_project_id("YOUR_PROJECT") issues = client.issues({"projectId[]":[project_id], "sort": "dueDate"}) # specified issue issue = client.issue("YOUR_PROJECT-999") # create issue project_id = client.get_project_id(project_key) issue_type_id = client.project_issue_types(project_key)[0][u"id"] priority_id = client.priorities()[0][u"id"] client.create_issue(project_id, u"some summary", issue_type_id, priority_id, {"description": u"a is b and c or d."}) # add comment client.add_issue_comment("YOUR_PROJECT-999", u"or ... else e.") # top 10 star collector star_collectors = [(client.user_stars_count(u[u"id"], {"since": "2017-06-01", "until": "2017-06-30"})[u"count"], u[u"name"]) for u in client.users()] star_collectors.sort() star_collectors.reverse() for i, (c, u) in enumerate(star_collectors[:10]): print(i+1, c, u)

supported operations are pydoc pybacklog.BacklogClient

extra parameters are here => Backlog API Overview | Backlog Developer API | Nulab

Unsupported operations ?

Use do or let's write code and Pull Request.

from pybacklog import BacklogClient client = BacklogClient("your_space_name", "your_api_key") space = client.do("GET", "space") # GET /api/v2/space projects = client.do("GET", "projects", query_params={"archived": false} ) # GET /api/v2/projects?archived=false activities = client.do("GET", "projects/{project_id_or_key}/activities", url_params={"project_id_or_key": "myproj"}, query_params={"activityTypeId[]": [1, 2]} ) # GET /api/v2/projects/myproj/activities?activityTypeIds%5B%5D=1&activityTypeIds%5B%5D=2

see also Backlog API Overview | Backlog Developer API | Nulab

Development

pip install -r requirements.txt pip install -r requirements_dev.txt PYTHONPATH=. python -m unittest tests 

License

Copyright 2017 Toshiaki Baba

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

Backlog API v2 Client

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages