Skip to main content

Backlog API v2 wrapper

Project description


A Python package wraps Backlog API V2



pip install python-backlog

Code snipet

import base64
import json
from backlog.base import BacklogAPI

def main():
    Initialize API Object
    api = BacklogAPI("your-space", "your-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.


Feature backlog.util.load_conf will omit in future. Because there is only little significance in supporting a specific format in this package. (see #17)

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.

Source Distribution

python-backlog-0.3.1.tar.gz (8.7 kB view hashes)

Uploaded source

Built Distribution

python_backlog-0.3.1-py3-none-any.whl (10.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page