aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authornico <nico@magicbroccoli.de>2019-12-11 17:31:21 +0100
committernico <nico@magicbroccoli.de>2019-12-11 17:31:21 +0100
commit825353e79e51b841d4783b6e187afa083a729e24 (patch)
treea7d199355ae9360c0828957329358bbb6283ff5f /README.md
parent9080c719dc0252b43fd894d71cf7d410ae8b0cb6 (diff)
TSGroupAssigner setup
+ working release TSGroupAssigner module + add GPL Licence + add basic README * updated .gitignore - remove old script snippets
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fbb4ee1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# TeamSpeak GroupAssigner
+
+## Overview
+TSGroupAssigner is a module which allows to automatically assign server groups to voice clients, if they connect within
+a specified date range.
+
+### example
+This small example could be called on the 23.12 to assign the group `24` to every voice client connecting
+to the server id `1`.
+The process will terminate gracefully when the configured date range is exceeded.
+
+```python
+import datetime as dt
+import logging
+from TSGroupAssigner import GroupAssigner
+
+logger = logging.getLogger()
+logger.setLevel(logging.INFO)
+
+creds = {
+ 'host': 'localhost',
+ 'port': 10011,
+ 'user': 'serveradmin',
+ 'password': '5up3r_53cr37',
+ 'sid': 1,
+ 'gid': 24
+}
+
+target = dt.date(year=2019, month=24, day=12)
+duration = dt.timedelta(days=2)
+
+GroupAssigner(date=target, delta=duration, **creds).start()
+```