Add documentation for class and show_logs

This commit is contained in:
Marcel Schwarz 2020-03-21 22:51:22 +01:00
parent 14c58905b8
commit 46491d3984

View File

@ -5,6 +5,7 @@ import re
class Teamspeak:
"""Manage a Docker backed Teamspeak server"""
def start(self):
"""Starts a Teamspeak Server with docker-compose"""
@ -27,4 +28,5 @@ class Teamspeak:
subprocess.run(f"tar -zcvf {name} ts3_data", shell=True, cwd=path.dirname(__file__))
def show_logs(self):
"""show the logs of the running Teamspeak server"""
subprocess.run("docker-compose logs", shell=True, cwd=path.dirname(__file__))