Skip to main content

Backlog API v2 wrapper

Project description


Backlog API V2対応のラッパーライブラリ



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
    print("# list project users")
    users = api.project.list_users("SampleProject")
    print(json.dumps(users, indent=2))

    Wiki API
    # list wikis
    print("# list wikis")
    wikis ="SampleProject")
    print(json.dumps(wikis[0], indent=2))

    # get attachment
    print("# get attachment")
    wiki = [w for w in"SampleProject") if len(w["attachments"]) > 0][0]
    attachment =
    attachment["data"] = base64.b64encode(attachment["data"]).decode()
    print(json.dumps(attachment, indent=2))

if __name__ == "__main__":


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



Twitter: hassaku63

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for python-backlog, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size python_backlog-0.1.3-py3-none-any.whl (10.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page