add pre-commit hooks

Author: Ableytner

.github/workflows/release_package.yml

@@ -73,17 +73,17 @@ jobs:
         echo "release-tag=$(echo $TAG)" >> $GITHUB_OUTPUT
     - uses: mukunku/tag-exists-action@v1.6.0
       id: check-tag
-      with: 
+      with:
         tag: ${{ steps.read-tag.outputs.release-tag }}
     - name: Fail if tag exists
       run: |
         echo "Tag ${{ steps.read-tag.outputs.release-tag }} exists!"
         exit 1
-      if: steps.check-tag.outputs.exists == 'true' 
+      if: steps.check-tag.outputs.exists == 'true'
     - name: Print tag if it doesn't exist
       run: |
         echo "Tag ${{ steps.read-tag.outputs.release-tag }} doesn't yet exist and can be created"
-      if: steps.check-tag.outputs.exists == 'false' 
+      if: steps.check-tag.outputs.exists == 'false'
 
   release:
     needs: [pylint, pytest, build, tag]

.github/workflows/run-tests.yml

@@ -1,6 +1,6 @@
 name: Run Tests
 
-on: 
+on:
   push:
     branches: [main]
   pull_request:

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  - id: check-yaml
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.4.1
+  hooks:
+  - id: codespell
+    files: ^.*\.(py|md|yml)$
+    exclude: >
+      (?x)^(
+        src/test/fuzzy_test.py|
+        src/test/alg_test.py
+      )$
+    additional_dependencies:
+    - tomli
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.12.10
+  hooks:
+  - id: ruff-check
+    args:
+      - --fix
+      - --unsafe-fixes
+- repo: https://github.com/pycqa/isort
+  rev: 6.0.1
+  hooks:
+  - id: isort
+    name: isort (python)
+- repo: https://github.com/pycqa/pylint
+  rev: v3.3.8
+  hooks:
+  - id: pylint
+    args:
+    - -d import-error
+    - -sn

README.md

@@ -57,23 +57,41 @@ Finally, the server is stopped gracefully.
 
 More examples can be found in the **examples** folder.
 
-## Run tests locally
+## Development environment setup
 
-In order to run tests locally, there are a few things that have to be setup:
+If you want to contribute to this project, you need to set up your local environment.
 
-### Add credentials for testing
+### Clone the repository
 
-To simulate a player connecting ot the server, it needs to authenticate against microsofts servers. This means, that a microsoft account which owns Minecraft is needed. Don't worry, the credentials are only saved locally.
+Run the command
+```bash
+git clone https://github.com/mcserver-tools/mcserverwrapper
+cd mcserverwrapper
+```
+in your terminal.
 
-Create a new file named *password.txt* in the repository root and add the following content (without the brackets):
+### Install pip packages
+
+To install all optional as well as development python packages, run the following commands in the project root.
+
+Windows:
+```bash
+py -m venv venv
+venv\Scripts\activate.bat
+pip install -r requirements.txt
 ```
-(username-here)
-(password-here)
+
+Linux:
+```bash
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
 ```
 
 ### Node
 
 Node 20 is needed to use MineFlayer.
+The install instructions can be found below:
 
 #### Windows
 
@@ -98,9 +116,41 @@ To actually run a minecraft server, a Java 21 JRE needs to be installed and adde
 
 Download it from (here)[https://adoptium.net/temurin/releases/].
 
+### Add credentials for testing
+
+To simulate a player connecting to the server, it needs to authenticate against microsofts servers. This means, that a microsoft account which owns Minecraft is needed. Don't worry, the credentials are only saved locally.
+
+Create a new file named *password.txt* in the repository root and add the following content (without the brackets):
+```
+(username-here)
+(password-here)
+```
+
 ### Run tests
 
 After installing all of the requirements, the tests can be ran using
 ```bash
-python -m pytest
+python -m pytest src -rs --skip-linting --skip-test-all
+```
+
+If you want to run tests for all Minecraft versions, remove the `--skip-test-all` argument from the command above.
+
+> **Warning**
+> Beware that testing all versions can take multiple hours!
+
+### Git pre-commit hooks
+
+Pre-commit hooks are used to check and autofix formatting issues and typos before you commit your changes.
+Once installed, they run automatically if you run `git commit ...`.
+
+Using these is optional, but encouraged.
+
+```bash
+pip install pre-commit
+pre-commit install
+```
+
+To verify the installation and run all checks:
+```bash
+pre-commit run --all-files
 ```

examples/example_01.py

@@ -4,6 +4,7 @@
 import pathlib
 
 import requests
+
 from mcserverwrapper import Wrapper
 
 def download_server_jar():

pyproject.toml

@@ -39,6 +39,7 @@ dependencies = [
 dev = [
   "bs4==0.0.2",
   "javascript==1!1.2.6",
+  "pre-commit==4.3.0",
   "pylint==3.3.9",
   "pytest==8.4.2",
   "requests==2.32.5",

requirements.txt

@@ -2,6 +2,7 @@ bs4==0.0.2
 javascript==1!1.2.6
 mcstatus==12.0.5
 pexpect==4.9.0
+pre-commit==4.3.0
 pylint==3.3.9
 pytest==8.4.2
 requests==2.32.5

src/mcserverwrapper/error.py

@@ -4,4 +4,4 @@ class McServerWrapperError(Exception):
     """The base exception, can be used to catch all other McServerWrapper-related errors"""
 
 class ServerExitedError(McServerWrapperError):
-    """An error occuring if the minecraft server unexpectedly crashed"""
+    """An error occurring if the minecraft server unexpectedly crashed"""

src/mcserverwrapper/server/base_server.py

@@ -1,4 +1,4 @@
-"""A module contining the base server class"""
+"""A module containing the base server class"""
 
 from __future__ import annotations
 

src/mcserverwrapper/server/server_builder.py

@@ -33,7 +33,7 @@ def from_jar(cls, jar_file: str) -> ServerBuilder:
 
         Args:
             jar_file (str): the full or relative path to the jar file to be used to start the server
-        
+
         Returns:
             ServerBuilder: a new ServerBuilder instance
         """