From a3191a37163774d9a7cbb39b6cc7295888936404 Mon Sep 17 00:00:00 2001 From: sebastian_kraetzig Date: Wed, 25 Jan 2023 21:01:36 +0100 Subject: [PATCH 1/3] Remove unused git submodules stuff --- .gitmodules | 3 --- docs/INSTALLATION.md | 5 ++--- docs/UPDATE.md | 5 ++--- 3 files changed, 4 insertions(+), 9 deletions(-) delete mode 100644 .gitmodules diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 20ef671..0000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "ts3"] - path = ts3 - url = https://github.com/Murgeye/ts3API.git diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index aaa227e..bd2709b 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -25,9 +25,8 @@ Software: 3. Switch into the project directory: `cd teamspeak3-python-bot/` 4. List available versions: `git tag` 5. Switch to the latest version: `git checkout ` -6. Update the Git submodules: `git submodule update --init --recursive` -7. Create your own config file: `cp config.example.ini config.ini` -8. Adjust the config file: `vim config.ini` (see [configuration](/docs/CONFIGURATION.md#configuration) for further information) +6. Create your own config file: `cp config.example.ini config.ini` +7. Adjust the config file: `vim config.ini` (see [configuration](/docs/CONFIGURATION.md#configuration) for further information) Instead of setting up the above Python virtual env, you can also skip the steps 4 and 5 and instead install the dependencies globally. However, this is not recommended as you could run other Python projects on the same system, which require then a different version of specific dependencies. diff --git a/docs/UPDATE.md b/docs/UPDATE.md index 5d1754b..f093c5e 100644 --- a/docs/UPDATE.md +++ b/docs/UPDATE.md @@ -17,11 +17,10 @@ There might be some breaking changes, which will affect your installation. Pleas 5. Switch to the respective newer version: `git checkout ` 6. Confirm, that you are on the respective new version: `git branch` (marked with a star in front of the line) 7. If necessary, apply the necessary changes for the breaking changes from the release notes -8. Ensure, that you have the respective Git submodules installed: `git submodule update --init --recursive` -9. Ensure, that you have the respective Python requirements installed: +8. Ensure, that you have the respective Python requirements installed: - The systemd unit does this automatically. This is only needed, when you run the bot different. - Activate the Python virtual environment: `source venv/bin/activate` - Install the requirements: `pip3 install -r requirements.txt` -10. Restart the bot: `sudo systemctl restart teamspeak-bot.service` +9. Restart the bot: `sudo systemctl restart teamspeak-bot.service` That's it. Your bot should be updated now and connected to your TeamSpeak server again. From ac1108546737e3d0f3f6bf15f443f02124f4cbc9 Mon Sep 17 00:00:00 2001 From: sebastian_kraetzig Date: Wed, 25 Jan 2023 21:04:14 +0100 Subject: [PATCH 2/3] Add missing Python file extensions in readme --- docs/INSTALLATION.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index bd2709b..7cbceea 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -51,7 +51,7 @@ pip3 install -r requirements.txt Then, simply start the bot: ```shell -./main +./main.py ``` You will not see any output, but when you check the `logs/` directory, you should see some log files. The bot should be also connected to your TeamSpeak server. Right now, it's just not doing anything as no plugin is configured yet. @@ -61,7 +61,7 @@ You can stop the bot by aborting the above command using the key combination `Ct If you want to run it like this, simply run the following command to put the process into the background: ```shell -./main & +./main.py & ``` ## Advanced (recommended) From 9323cdb5c083f6e609ec16ed3dfdb4f4d1a35c54 Mon Sep 17 00:00:00 2001 From: sebastian_kraetzig Date: Wed, 25 Jan 2023 21:13:19 +0100 Subject: [PATCH 3/3] Pin specific ts3API version --- requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index b4d05d3..2aa2f49 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ -ts3API[ssh] +# https://github.com/Murgeye/teamspeak3-python-api +ts3API[ssh]==0.9.4 # Only for fixing this Pylint error: ModuleNotFoundError: No module named 'typing_extensions' # See https://github.com/Sebi94nbg/teamspeak3-python-bot/actions/runs/3864557425/jobs/6587510172