Skip to content
Author adaptive cards in native python
Python Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Initial commit Oct 30, 2019
docs added docstrings to actions Nov 1, 2019
pyadaptivecards Fixed error where max/min was not respected due to it being a str in … Nov 13, 2019
tests Initial commit Oct 30, 2019
.editorconfig
.gitignore Initial commit Oct 30, 2019
.travis.yml Initial commit Oct 30, 2019
AUTHORS.rst Initial commit Oct 30, 2019
CODE_OF_CONDUCT.rst Initial commit Oct 30, 2019
CONTRIBUTING.rst Initial commit Oct 30, 2019
HEADER Initial commit Oct 30, 2019
HISTORY.rst Initial commit Oct 30, 2019
LICENSE Initial commit Oct 30, 2019
MANIFEST.in Initial commit Oct 30, 2019
Makefile Initial commit Oct 30, 2019
README.md Update README.md Nov 20, 2019
cards_sample.png Added screenshot and updated readme Oct 30, 2019
requirements_dev.txt Initial commit Oct 30, 2019
setup.cfg Initial commit Oct 30, 2019
setup.py Added readme and pushed to pypi Oct 30, 2019
tox.ini Initial commit Oct 30, 2019

README.md

PyAdaptiveCards

Author adaptive cards in pure python

PyPi ReadTheDocs PyUp


Introduction

Adaptive Cards are a great way to extend your bot interactions. However, writing the JSON required to specify the card layout by hand can be cumbersome and error prone. And while using a designer is a good way to manually create cards this does not cover cards that are generated by code. PyAdaptiveCards allows you to author cards in native python without ever touching the underlying json.

A code sample says more then a thousand words so the following code snippet ...

from pyadaptivecards.card import AdaptiveCard
from pyadaptivecards.inputs import Text, Number
from pyadaptivecards.components import TextBlock
from pyadaptivecards.actions import Submit

greeting = TextBlock("Hey hello there! I am a adaptive card")
first_name = Text('first_name', placeholder="First Name")
age = Number('age', placeholder="Age")

submit = Submit(title="Send me!")

card = AdaptiveCard(body=[greeting, first_name, age], actions=[submit])
card_json = card.to_json(pretty=True)
print(card_json)

... produces this json ...

{
    "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
    "actions": [
        {
            "title": "Send me!",
            "type": "Action.Submit"
        }
    ],
    "body": [
        {
            "text": "Hey hello there! I am a adaptive card",
            "type": "TextBlock"
        },
        {
            "id": "first_name",
            "placeholder": "First name",
            "type": "Input.Text"
        },
        {
            "id": "age",
            "placeholder": "Age",
            "type": "Input.Number"
        }
    ],
    "type": "AdaptiveCard",
    "version": "1.1"
}

... which looks like this in Webex Teams ...

screenshot of card in webex teams

Usage with Webex Teams

Below is an example how to use pyadaptivecards with Webex Teams.

Using raw requests

import requests 
import json

from pyadaptivecards.card import AdaptiveCard
from pyadaptivecards.inputs import Text, Number
from pyadaptivecards.components import TextBlock
from pyadaptivecards.actions import Submit

auth_token = "<INSERT_AUTH_TOKEN_HERE>"
headers = {
    "Authorization": "Bearer " + auth_token
}

# Create card
greeting = TextBlock("Hey hello there! I am a adaptive card")
first_name = Text('first_name', placeholder="First Name")
age = Number('age', placeholder="Age")

submit = Submit(title="Send me!")

card = AdaptiveCard(body=[greeting, first_name, age], actions=[submit])

# Create attachment
attachment = {
    "contentType": "application/vnd.microsoft.card.adaptive",
    "content": card.to_dict()
}

# Create payload for the webrequest
payload = {
    "roomId": "<INSERT_YOUR_ROOM_HERE>",
    "attachments" : [attachment],
    "text": "Fallback Text"
}

response = requests.post("https://api.ciscospark.com/v1/messages", headers=headers, data=payload)

Using the webexteamssdk

The webexteamssdk provides a great wrapper around the Webex Teams API that can be used to interact with the API in native python. The following example shows how to use pyadaptivecards with the newly implemented attachments option.

from pyadaptivecards.card import AdaptiveCard
from pyadaptivecards.inputs import Text, Number
from pyadaptivecards.components import TextBlock
from pyadaptivecards.actions import Submit

from webexteamssdk import WebexTeamsAPI

greeting = TextBlock("Hey hello there! I am a adaptive card")
first_name = Text('first_name', placeholder="First Name")
age = Number('age', placeholder="Age")

submit = Submit(title="Send me!")

card = AdaptiveCard(body=[greeting, first_name, age], actions=[submit])

# Create a webex teams api connection
api = WebexTeamsAPI()
room_id = "<INSERT_ROOM_ID_HERE>"
# Create a dict that will contain the card as well as some meta information
attachment = {
    "contentType": "application/vnd.microsoft.card.adaptive",
    "content": card.to_dict(),
}
api.messages.create(roomId=room_id, text="Fallback", attachments=[attachment])

Features

  • Supports all components, options and features of adaptive cards version 1.1
  • Create adaptive cards from pure python

Installation

You can install PyAdaptiveCards using pip by issuing

$ pip install pyadaptivecards

For more information on how to use this package please check the project documentation at https://pyadaptivecards.readthedocs.io.

Authors & Maintainers

Credits

The following resources were influential in the creation of this project:

License

This project is licensed to you under the terms of the Cisco SampleCode License.

You can’t perform that action at this time.