Easier Installation via setup.py or pip3

Author: derkalle4

README.md

@@ -5,3 +5,19 @@ TS3Proxy aims to be a complete solution for proxy ts3. It allows you to hide the
   - Proxy TS3 UDP Port
   - Proxy TS3 Filetransfer Port
   - Proxy TS3 Serverquery Port
+
+## HowTo install
+
+Just unzip the latest release (or master branch) zip file open a terminal in this folder:
+
+pip3 install -e .
+
+And just run it afterwards with an NON-ROOT user via command line:
+
+ts3proxy
+
+## HowTo run (Alternative)
+
+If you have installed all dependencies you can just run it with:
+
+python3 -m ts3proxy.ts3proxy

setup.py

@@ -0,0 +1,20 @@
+from setuptools import setup, find_packages
+
+
+install_requires = [
+    "PyYAML",
+]
+
+setup(
+    name="ts3proxy",
+    author="Karl-Martin Minkner",
+    author_email="[email protected]",
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=install_requires,
+    entry_points={
+        "console_scripts": [
+            "ts3proxy = ts3proxy.ts3proxy:main",
+        ],
+    },
+)

proxy/tcp.py ts3proxy/tcp.py

@@ -4,10 +4,11 @@
 import threading
 import yaml
 
-from proxy.udp import Udp
-from proxy.tcp import Tcp
+from .udp import Udp
+from .tcp import Tcp
 
-if __name__ == '__main__':
+
+def main():
     try:
         with open("config.yml", 'r') as stream:
             try:
@@ -37,3 +38,6 @@
         t3.start()
     except KeyboardInterrupt:
         exit(0)
+
+if __name__ == '__main__':
+    main()