Skip to main content

Backlog API v2 wrapper

Project description

pbl

A Python package wraps Backlog API V2

Usage

Install

pip install python-backlog

Code snippet

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
    # 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()

See also

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

Contact

Twitter: hassaku_63

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.7.4.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

python_backlog-0.7.4-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

Details for the file python_backlog-0.7.4.tar.gz.

File metadata

  • Download URL: python_backlog-0.7.4.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for python_backlog-0.7.4.tar.gz
Algorithm Hash digest
SHA256 20a3293cca1acd95adf522da1c0409cd684d8a99e3751fafa950a683c023657c
MD5 d666ebce84033db0586cd0968f982d4b
BLAKE2b-256 0ec57a14724b0c3576d7ad625d78e418d46be867674406236e8f467491cc5261

See more details on using hashes here.

File details

Details for the file python_backlog-0.7.4-py3-none-any.whl.

File metadata

File hashes

Hashes for python_backlog-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bed9c3306f8fc985bf085e02ce1672466fd2fab07a36c9c4fda8e2df61992fdb
MD5 26312cd043b20c08fa813bb547db96d2
BLAKE2b-256 c91b7a2c98c475ad2ff77ed37d4e1e473120c8cb0a57084118dd17b9b282f146

See more details on using hashes here.

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