Metadata-Version: 2.1
Name: ikakao
Version: 0.0.9
Summary: Kakao i Open Builder SDK
Home-page: https://github.com/hallazzang/ikakao
Author: Hanjun Kim
Author-email: hallazzang@gmail.com
License: UNKNOWN
Description: # ikakao
        
        [![shields-pypi-badge]](https://pypi.org/project/ikakao/)
        
        [shields-pypi-badge]: https://img.shields.io/pypi/v/ikakao?style=flat-square&color=blue
        
        Kakao i Open Builder SDK (Currently WIP)
        
        ## Roadmap
        
        ### Supported Components
        
        - [x] SimpleText
        - [x] SimpleImage
        - [x] ListCard
        - [ ] BasicCard (Partial support)
        - [ ] CommerceCard
        - [ ] Carousel (Partial support)
        - [ ] QuickReply (Partial support)
        
        ## Usage Examples
        
        Here are some examples demonstrating various types of skill responses.
        
        ### Simple Text
        
        ```python
        import json
        
        from ikakao.skill import Response
        
        r = Response("Hello, Kakao i!")
        print(json.dumps(r.to_dict(), indent=2))
        ```
        
        Output:
        ```json
        {
          "version": "2.0",
          "template": {
            "outputs": [
              {
                "simpleText": {
                  "text": "Hello, Kakao i!"
                }
              }
            ]
          }
        }
        ```
        
        ### Multiple Text w/ Quick Reply
        
        ```python
        import json
        
        from ikakao.skill import Response
        
        r = Response("Hello", "Kakao", "i", quick_replies="Home")
        print(json.dumps(r.to_dict(), indent=2))
        ```
        
        Output:
        ```json
        {
          "version": "2.0",
          "template": {
            "outputs": [
              {
                "simpleText": {
                  "text": "Hello"
                }
              },
              {
                "simpleText": {
                  "text": "Kakao"
                }
              },
              {
                "simpleText": {
                  "text": "i"
                }
              }
            ],
            "quickReplies": [
              {
                "label": "Home",
                "action": "message",
                "messageText": "Home"
              }
            ]
          }
        }
        ```
        
        ### Carousel
        
        ```python
        import json
        
        from ikakao.skill import Response, BasicCard, Carousel
        
        carousel = Carousel(
          BasicCard("Title #1", "Description"),
          BasicCard("Title #2", "Description"),
          BasicCard("Title #3", "Description"),
        )
        r = Response("Carousel Example", carousel, quick_replies=["Home", "Cancel"])
        print(json.dumps(r.to_dict(), indent=2))
        ```
        
        Output:
        ```json
        {
          "version": "2.0",
          "template": {
            "outputs": [
              {
                "simpleText": {
                  "text": "Carousel Example"
                }
              },
              {
                "carousel": {
                  "type": "basicCard",
                  "items": [
                    {
                      "title": "Title #1",
                      "description": "Description"
                    },
                    {
                      "title": "Title #2",
                      "description": "Description"
                    },
                    {
                      "title": "Title #3",
                      "description": "Description"
                    }
                  ]
                }
              }
            ],
            "quickReplies": [
              {
                "label": "Home",
                "action": "message",
                "messageText": "Home"
              },
              {
                "label": "Cancel",
                "action": "message",
                "messageText": "Cancel"
              }
            ]
          }
        }
        ```
        
        ### ListCard
        
        ```python
        import json
        
        from ikakao.skill import Response, ListCard, ListItem
        
        list_card = ListCard(
          "Header",
          "Item #1",
          ListItem("Item #2", link="http://example.com"),
          buttons=["Button #1", "Button #2"],
        )
        r = Response("ListCard Example", list_card, quick_replies=["Home", "Cancel"])
        print(json.dumps(r.to_dict(), indent=2))
        ```
        
        Output:
        ```json
        {
          "version": "2.0",
          "template": {
            "outputs": [
              {
                "simpleText": {
                  "text": "ListCard Example"
                }
              },
              {
                "listCard": {
                  "header": {
                    "title": "Header"
                  },
                  "items": [
                    {
                      "title": "Item #1"
                    },
                    {
                      "title": "Item #2",
                      "link": {
                        "web": "http://example.com"
                      }
                    }
                  ],
                  "buttons": [
                    {
                      "label": "Button #1",
                      "action": "message",
                      "messageText": "Button #1"
                    },
                    {
                      "label": "Button #2",
                      "action": "message",
                      "messageText": "Button #2"
                    }
                  ]
                }
              }
            ],
            "quickReplies": [
              {
                "label": "Home",
                "action": "message",
                "messageText": "Home"
              },
              {
                "label": "Cancel",
                "action": "message",
                "messageText": "Cancel"
              }
            ]
          }
        }
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Requires-Python: >=3.6
Description-Content-Type: text/markdown
