Fix/switch method for exporting cards as dicts (#23)

* [doc] Add TOC and documentation about sending cards

resolves #21

* [feat] Rename example and add sending card functionality

resolves #21

* [feat] Add MS Teams client for sending cards

resolves #21

* [feat] Add sending card functionality to example

resolves #21

* [refactor] Auto re-formatting applied

* Merge branch 'main' of https://github.com/dennis6p/adaptive-cards into main

* [fix] Switch method for exporting card as dict in client.send()

* [refactor] Remove unused import

* [refactor] Remove superfluous file

Author: dennis6p

README.md

@@ -26,7 +26,7 @@ If you are interested in the general concepts of adaptive cards and want to dig
 ## About
 
 This library is intended to provide a clear and simple interface for creating adaptive cards with only a few lines of code in a more robust way. The heavy usage of Python's typing library should
-prevent one from creating invalid schemes and structures. Instead, creating cards should be intuitive and work like a breeze.
+prevent one from creating invalid schemes and structures. Instead, creating cards and sending cards should be intuitive and work like a breeze.
 
 For a comprehensive introduction into the main ideas and patterns of adaptive cards, have a look on the [**official documentation**](https://docs.microsoft.com/en-us/adaptive-cards). I also recommend using the [**schema explorer**](https://adaptivecards.io/explorer) page alongside the implementation, since the library's type system relies on these schemes.
 
@@ -39,12 +39,14 @@ For a comprehensive introduction into the main ideas and patterns of adaptive ca
 + Schema validation for version compatibility
 + Simple `JSON` export
 + Compliant with the official structures and ideas
++ Send cards to MS Teams via `TeamsClient`
 
 ## Dependencies
 
 * Python 3.10+
 * `dataclasses-json`
 * `StrEnum`
+* `requests`
 
 ## Installation
 

adaptive_cards/card.py

@@ -1,7 +1,7 @@
 """Implementation of the adaptive card type"""
 
 from dataclasses import dataclass, field
-from typing import Optional, Sequence
+from typing import Optional, Sequence, Any
 from dataclasses_json import dataclass_json, LetterCase
 from adaptive_cards.actions import SelectAction, ActionTypes
 from adaptive_cards.containers import ContainerTypes
@@ -375,3 +375,12 @@ def to_json(self) -> str:
             str: Adaptive card schema as JSON string.
         """
         return self.to_json()
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Converts the full adaptive card schema into a dictionary.
+
+        Returns:
+            str: Adaptive card schema as dictionary.
+        """
+        return self.to_dict()

adaptive_cards/client.py

@@ -7,7 +7,6 @@
 """  # pylint: disable=line-too-long
 
 from typing import Any
-from dataclasses import asdict
 from http import HTTPStatus
 import requests
 
@@ -33,7 +32,7 @@ def _create_attachment(card: AdaptiveCard) -> dict:
         Returns:
             dict: A dictionary representing the attachment.
         """
-        content: dict[str, Any] = asdict(card)
+        content: dict[str, Any] = card.to_dict()
         return {
             "contentType": "application/vnd.microsoft.card.adaptive",
             "contentUrl": None,

examples/simple_card/simple_card.py

@@ -1,11 +1,13 @@
 """Example: simple card"""
 
+from requests import Response
 from adaptive_cards.elements import TextBlock
 import adaptive_cards.card_types as types
 from adaptive_cards.card import AdaptiveCard
 from adaptive_cards.validation import SchemaValidator, Result
 from adaptive_cards.client import TeamsClient
 
+
 text_block: TextBlock = TextBlock(
     text="It's your second card",
     color=types.Colors.ACCENT,
@@ -26,4 +28,4 @@
 # send card
 webhook_url: str = "YOUR-URL"
 client: TeamsClient = TeamsClient(webhook_url)
-client.send(card)
+response: Response = client.send(card)

examples/wrap_up_card/wrap_up_card.py

@@ -3,6 +3,7 @@
 # pylint: disable=C0413
 
 import sys
+from requests import Response
 
 sys.path.append("../../")
 import adaptive_cards.card_types as types
@@ -169,4 +170,4 @@
 # send card
 webhook_url: str = "YOUR-URL"
 client: TeamsClient = TeamsClient(webhook_url)
-client.send(card)
+response: Response = client.send(card)