backlog_util

チーム横断のタスクを一斉起票したりするのが面倒くさいので、それの省力化を目指す

このレポジトリでは、coreutil的なパッケージの開発を目指す。別レポジトリでこれをラップしたCLIインタフェースの開発を行う。

Usage

Install

git clone [email protected]:hassaku63/backlog_util.git
cd /path/to/this/package
pip install .

# or
pip install git+git://github.com/hassaku63/backlog_util@<BRANCH_NAME>

Code snipet

import base64
import json
from backlog.util import load_conf
from backlog.base import BacklogAPI


def main():
    """
    Load conf.yml
    """
    conf = load_conf("conf.yml")["backlog"]
    api = BacklogAPI(conf["space"], conf["api_key"])

    """
    Project API
    """
    # list project users
    # https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-project-list/
    print("# list project users")
    users = api.project.list_users("SampleProject")
    print(json.dumps(users, indent=2))


    """
    Wiki API
    """
    # list wikis
    # https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-wiki-page-list/
    print("# list wikis")
    wikis = api.wiki.list("SampleProject")
    print(json.dumps(wikis[0], indent=2))

    # get attachment
    # https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-issue-attachment/
    print("# get attachment")
    wiki = [w for w in api.wiki.list("SampleProject") if len(w["attachments"]) > 0][0]
    attachment = api.wiki.get_attachment(
        wikiId=wiki["id"],
        attachmentId=wiki["attachments"][0]["id"])
    attachment["data"] = base64.b64encode(attachment["data"]).decode()
    print(json.dumps(attachment, indent=2))


if __name__ == "__main__":
    main()

Auth

Oct 2018, Currently API Key is supported. NOT support OAuth2 yet.

API Client object is initialized with arguments credentials(space and api_key).

This package provides a helper function to loading config yaml. This helper function is provided by backlog.util.load_conf .

load_conf takes an argument path to yaml file. By defalt, ./conf.yml is given.

See also

Qiita https://qiita.com/hassaku_63/items/b9eb2a1c7ecd3c19507d

Contact

key	value
Slack internal team	#ext-dev-backlog-util @hashimoto
Twitter	https://twitter.com/hassaku_63