Backlog API v2 wrapper
Project description
pbl
Backlog API V2対応のラッパーライブラリ
Usage
Install
pip install python-backlog
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
Twitter: hassaku63
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
python-backlog-0.2.0.tar.gz
(7.7 kB
view hashes)
Built Distribution
Close
Hashes for python_backlog-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7399bbc1c21cb878b039d392fb058c63417c7c91d7308d2a40184864e17e9d2 |
|
MD5 | 74c135ada9843e4b3148ed35bc801935 |
|
BLAKE2b-256 | c1e2ee05f290c13169dd8debb0b972375fa8a21e4bd63c638df26aa2abd6cfd2 |