Metadata-Version: 2.1
Name: python-backlog
Version: 0.2.0
Summary: Backlog API v2 wrapper
Home-page: UNKNOWN
Author: hassaku63
Author-email: takuyahashimoto1988@gmail.com
License: MIT
Description: # pbl
        Backlog API V2対応のラッパーライブラリ
        
        # Usage
        
        Install
        
        ```bash
        pip install python-backlog
        ```
        
        
        Code snipet
        
        ```python
        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](https://twitter.com/hassaku_63)
        
Keywords: nulab backlog
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Natural Language :: Japanese
Description-Content-Type: text/markdown
