pybacklog

Backlog API v2 Client Library for Python

Requirements

• Python 3.10+
• requests 2.x

Usage: install

pip install pybacklog

Usage: code

from pybacklog import BacklogClient
import os

YOUR_SPACE_NAME = os.getenv("BACKLOG_SPACE_NAME", "")
YOUR_API_KEY = os.getenv("BACKLOG_API_KEY", "")
YOUR_PROJECT = os.getenv("BACKLOG_PROJECT", "")
YOUR_ISSUE_KEY = os.getenv("BACKLOG_ISSUE_KEY", "")

client = BacklogClient(YOUR_SPACE_NAME, YOUR_API_KEY)

# space
space = client.space()
print(space.get("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_ISSUE_KEY)

# create issue
project_id = client.get_project_id(YOUR_PROJECT)
issue_type_id = client.project_issue_types(YOUR_PROJECT)[0]["id"]
priority_id = client.priorities()[0]["id"]

if project_id and issue_type_id and priority_id:
    client.create_issue(project_id, "some summary", issue_type_id, priority_id, {"description": "a is b and c or d."})

# add comment
client.add_issue_comment(YOUR_ISSUE_KEY, "or ... else e.")

# top 10 star collector
star_collectors = [
    (client.user_stars_count(u["id"], {"since": "2017-06-01", "until": "2017-06-30"})["count"], 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
import os

YOUR_SPACE_NAME = os.getenv("BACKLOG_SPACE_NAME", "")
YOUR_API_KEY = os.getenv("BACKLOG_API_KEY", "")
YOUR_PROJECT = os.getenv("BACKLOG_PROJECT", "")

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": YOUR_PROJECT},
    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

uv sync --group dev
uv run python3 -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.