Skip to main content

Microsoft Teams AdaptiveCards API Wrapper for Python 2 and 3

Project description

Stand With Ukraine Made in Ukraine Stand With Ukraine Russian Warship Go Fuck Yourself

Microsoft Teams AdaptiveCards API Wrapper for Python 2 and 3

Repository: https://github.com/ALERTua/msteamsapi
PyPi: https://pypi.org/project/msteamsapi/

Package and PyPi Upload DEV Package and TestPyPi Upload Commit Checks

Usage

  • pip install msteamsapi
  • Get a Workflow Webhook URL for your MSTeams non-private(!) channel using the standard template Post to a channel when a webhook request is received.
  • Use the Webhook URL to instantiate TeamsWebhook class.
  • Fill the TeamsWebhook with AdaptiveCard.
  • Fill the AdaptiveCard with Container.
  • Fill the Container with FactSet, TextBlock, etc.
  • send() the TeamsWebhook instance.

Example from tests/test_suite.py:

from msteamsapi import TeamsWebhook, AdaptiveCard, Container, FactSet, ContainerStyle, TextWeight, TextSize

webhook = TeamsWebhook('your_webhook_url')

card = AdaptiveCard(title='card title', title_style=ContainerStyle.DEFAULT)
card.add_background(url="https://github.com/ALERTua/msteamsapi/raw/main/tests/background.png")

container = Container(style=ContainerStyle.DEFAULT)

card.mention('EMAIL', 'NAME', add_text_block=True)
mention_tag = card.mention('EMAIL', 'mention text')

container.add_image("image url", "image alt text")
container.add_text_block(
    'multiline\n\ntext\n\nmention 1: %s' % mention_tag,
    size=TextSize.DEFAULT, weight=TextWeight.DEFAULT, color="default"
)

factset = FactSet(('fact 1', 'fact 1 value'))
factset.add_facts(('fact 2', 'fact 2 value'), ('fact 3', 'fact 3 value'))
container.add_fact_set(factset)

card.add_container(container)

for i, url in enumerate(['https://google.com/', 'https://goo.gle']):
    card.add_url_button('url %s' % i, url)

webhook.add_cards(card)
webhook.send()

Your contribution is appreciated.

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

msteamsapi-0.9.3.tar.gz (5.7 kB view hashes)

Uploaded Source

Built Distribution

msteamsapi-0.9.3-py2.py3-none-any.whl (7.2 kB view hashes)

Uploaded Python 2 Python 3

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