From 74ba2860e45560d7689e7cc083ab1083dad3ec6c Mon Sep 17 00:00:00 2001 From: missytake Date: Sun, 8 Oct 2023 11:37:10 +0200 Subject: [PATCH] pyinfra: added docstring --- src/teams_bot/pyinfra.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/teams_bot/pyinfra.py b/src/teams_bot/pyinfra.py index b2ab33b..4cec8b1 100644 --- a/src/teams_bot/pyinfra.py +++ b/src/teams_bot/pyinfra.py @@ -5,7 +5,13 @@ from pyinfra.operations import git, server, files, systemd def deploy_teams_bot(unix_user: str, bot_email: str, bot_passwd: str, dbdir: str = None): - """Deploy TeamsBot to a UNIX user""" + """Deploy TeamsBot to a UNIX user, with specified credentials + + :param unix_user: the existing UNIX user of the bot + :param bot_email: the email address for the bot account + :param bot_passwd: the password for the bot's email account + :param dbdir: the directory where the bot's data will be stored. default: ~/.config/teams-bot/email@example.org + """ clone_xdcget = git.repo( name="Pull the teams-bot repository",