Berichten naar Microsoft Teams sturen met Python

In beide gevallen eindig je met een DataLab-werkboek waarin je businesslogica helemaal is uitgewerkt:

3. Een bericht naar Teams sturen

Dus: Teams-webhook, check. Businesslogica, check. Om het Python-notebook met Microsoft Teams te integreren, moeten we twee dingen doen: de webhook-URL in het DataLab-werkboek opslaan en Python-code schrijven om een bericht naar het Teams-kanaal te sturen.

Sla de webhook-URL op

Ons Python-notebook heeft de webhook-URL nodig om het bericht naar het juiste Teams-kanaal te sturen. Je zou deze URL gewoon kunnen kopiëren en plakken in een codecel van je notebook. Dit is echter niet veilig en niet aan te raden. De webhook-URL is eigenlijk geheim. Als je je notebook met iemand anders deelt, kan die persoon de webhook-URL zien en je Teams-kanaal spammen!

Bovendien zou je deze kopieer- en plakactie moeten herhalen in elk werkboek waarmee je Teams-berichten wilt sturen. Als je de webhook-URL om wat voor reden dan ook wilt updaten, moet je elk werkboek langs om het aan te passen.

Een veiligere en schaalbaardere aanpak is om de webhook-URL-token op te slaan in een zogeheten omgevingsvariabele. Wanneer je deze omgevingsvariabele koppelt, wordt hij beschikbaar in je Python-sessie. In je werkboek:

• Klik op het tabblad “Environment” aan de linkerkant
• Klik op het plusteken naast “Environment Variables”
• In de modal “Add Environment Variables”:
• Zet “Name” op MS_TEAMS_WEBHOOK_URL
• Plak in het veld “Value” de webhook-URL die je eerder hebt opgeslagen.
• Zet “Environment Variables Set Name” op “Microsoft Teams” (dit kan eigenlijk van alles zijn)

Klik na het invullen op “Create”, “Next” en tot slot op “Connect”. Je werkboeksessie wordt herstart en MS_TEAMS_WEBHOOK_URL is nu beschikbaar als omgevingsvariabele in je werkboek. Je kunt dit verifiëren door een Python-cel met de volgende code te maken en uit te voeren:

import os
webhook_url = os.environ["MS_TEAMS_WEBHOOK_URL"]
print(webhook_url)

Wil je dezelfde serviceaccountreferenties in een ander werkboek hergebruiken, dan hoef je de omgevingsvariabele niet opnieuw in te stellen: je kunt de omgevingsvariabele in andere werkboeken hergebruiken.

Python-code om het Microsoft Teams-bericht te versturen

Met de MS_TEAMS_WEBHOOK_URL paraat kunnen we nu Python-code schrijven om een bericht naar Teams te sturen! Hiervoor gebruiken we het open-source pymsteams-pakket, dat een handige wrapper biedt voor de behoorlijk ingewikkelde API om berichten naar Teams te sturen. Laten we het installeren en importeren, samen met het os-pakket om omgevingsvariabelen uit te lezen:

!pip install pymsteams
import pymsteams
import os

Vervolgens kunnen we een zogeheten ‘connector card’ maken – een mooi woord voor een rich text-bericht in Teams –, er wat tekst aan toevoegen en hem versturen:

card = pymsteams.connectorcard(os.environ["MS_TEAMS_WEBHOOK_URL"])
card.text("Hello Teams!")
assert card.send()

Voer deze code uit! Je zou dit bericht in het kanaal moeten zien verschijnen:

Top! Dit was een nietszeggend voorbeeldbericht, maar je kunt ook een bericht maken op basis van het resultaat van je businesslogica, zoals we deden in het voorbeeldwerkboek:

card = pymsteams.connectorcard(os.environ["MS_TEAMS_WEBHOOK_URL"])
card.title("Weather Forecast")
card.text("\n".join([
    f"Weather for {CITY} in the next three days:",
    f"- Min temperature: {weather_df['temperature_2m'].min()} {unit_temperature}",
    f"- Max temperature: {weather_df['temperature_2m'].max()} {unit_temperature}", 
    f"- Total precipitation: {weather_df['precipitation'].sum():.2f} {unit_prec}"
]))
assert card.send()

Met het volgende resultaat:

Tot slot kun je ook de omgevingsvariabele DL_WORKBOOK_ID gebruiken om een knop toe te voegen die naar je werkboek linkt, voor het geval je een eenvoudige manier wilt bieden om vanuit Teams naar het DataLab-werkboek te gaan dat dit bericht aanstuurt:

card = pymsteams.connectorcard(os.environ["MS_TEAMS_WEBHOOK_URL"])
card.title("Weather Forecast")
card.text("\n".join([
    f"Weather for {CITY} in the next three days:",
    f"- Min temperature: {weather_df['temperature_2m'].min()} {unit_temperature}",
    f"- Max temperature: {weather_df['temperature_2m'].max()} {unit_temperature}", 
    f"- Total precipitation: {weather_df['precipitation'].sum():.2f} {unit_prec}"
]))
card.addLinkButton("View detailed forecast", f"https://www.datacamp.com/datalab/w/{os.environ.get('DL_WORKBOOK_ID', 'invalid')}/edit")
assert card.send()

Met het volgende resultaat:

Best netjes, toch?!

4. Automatiseren!

Je hebt een Python-script gemaakt dat een nuttige analyse uitvoert en een samenvatting daarvan naar Teams stuurt, inclusief een link terug naar het volledige notebook voor wie meer details wil. Top! Stel je nu voor dat je dit notebook automatisch kunt laten uitvoeren, dagelijks of wekelijks, zodat je continu up-to-date bent met verse resultaten. Goed nieuws: dat kan! DataLab biedt scheduled runs om dit mogelijk te maken.

• Klik in de menubalk bovenaan op Run > Schedule Run
• Stel het schema in zoals jij wilt:
• Laat het notebook automatisch dagelijks of wekelijks draaien. Kies voor wekelijkse schema’s de exacte dag en tijd.
• Voeg DataCamp-gebruikers toe die je wilt informeren zodra het notebook klaar is (succesvol of met een fout). Handig bij fouten, zodat je meteen kunt inspringen en het probleem oplossen.

Als je het instelt zoals in de screenshot hierboven, draait het notebook nu elke dag om 9:30 uur lokale tijd, wat betekent dat er iedere ochtend een bericht in het opgegeven Teams-kanaal wordt geplaatst.

Automatiseren of niet

Niet elke taak leent zich goed voor automatisering. Het hangt af van hoe vaak je het doet, hoe lang het kost om het handmatig te doen en hoeveel tijd het kost om een Python-script te schrijven dat het automatiseert. Neem bijvoorbeeld een jaarlijks rapport dat 20 minuten kost om handmatig te maken. Als het je een halve dag kost om er een script voor te schrijven, duurt het jaren voordat je de geïnvesteerde tijd hebt terugverdiend!

Hier is een samenvatting in tabelvorm:

Bron: XKCD

Dus als een taak die je dagelijks moest doen eerder 5 minuten kostte, kun je tot 6 dagen besteden aan het automatiseren ervan. Besteed je minder tijd aan het automatiseren, dan heb je (over vijf jaar gerekend) tijd gewonnen.

Conclusie

Het opzetten van DataLab om berichten naar Microsoft Teams te sturen vraagt in het begin wat klikken door verschillende schermen. Maar zodra alles staat en de webhook-URL in DataLab is ingesteld, komt het verzenden van een bericht neer op een paar regels Python-code – superrechttoe rechtaan! Het mooiste? Je kunt bijna elk Python-script automatiseren en je stakeholders direct informeren, precies daar waar ze zijn: in Teams.

Weg met herinneringen voor repetitieve, saaie taken. Welkom in een tijdperk van efficiënte, geautomatiseerde workflows waarin je niet tussen tools hoeft te schakelen. Alles wat het kost, is DataLab omarmen.

Onthoud: heb je een opfrisser nodig voor het schrijven van Python-code, dan is onze cursus Introduction to Python de ideale plek om te beginnen.