test(ocpp-server): add tasks to format/lint code
[e-mobility-charging-stations-simulator.git] / tests / ocpp-server / README.md
index 332751d564533331cc43d066ca343ec15a16d231..e2a8149c90de427c31db970401e41df9f69377e0 100644 (file)
@@ -6,7 +6,7 @@ This project includes an Open Charge Point Protocol (OCPP) version 2.0.1 mock se
 
 This project requires Python 3.7+ and [poetry](https://python-poetry.org/) to install the required packages:
 
-```
+```shell
 poetry install
 ```
 
@@ -14,7 +14,7 @@ poetry install
 
 To start the server, run the `server.py` script:
 
-```
+```shell
 python server.py
 ```
 
@@ -28,6 +28,20 @@ The server script waits for connections from clients. When a client connects, th
 
 The server script uses the websockets and ocpp libraries to facilitate the WebSocket and OCPP communication.
 
+## Development
+
+### Code formatting
+
+```shell
+poetry run task format
+```
+
+### Code linting
+
+```shell
+poetry run task lint
+```
+
 ## Note
 
 Primarily, this software is intended for testing applications. The server script don't adhere to the full OCPP specifications and it is advised not to use them in a production environment without additional development.