missytake/team-bot
1
0
Fork 1
Code Issues 3 Pull requests Packages Projects Releases 4 Wiki Activity

pyinfra: added docstring

Browse source
This commit is contained in:
missytake 2023-10-08 11:37:10 +02:00
parent b8e43ac2b9
commit 74ba2860e4
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/teams_bot/pyinfra.py
View file

@ -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",