test(ocpp-server): add tasks to format/lint code

[e-mobility-charging-stations-simulator.git] / tests / ocpp-server / README.md

diff --git a/tests/ocpp-server/README.md b/tests/ocpp-server/README.md
index e02d8b7bdb2bf400ba7c3942903e31cc22853376..e2a8149c90de427c31db970401e41df9f69377e0 100644 (file)
--- a/tests/ocpp-server/README.md
+++ b/tests/ocpp-server/README.md
@@ -1,24 +1,20 @@
 # OCPP2 Mock Server
 
-This project includes a mock Open Charge Point Protocol (OCPP) version 2.0.1 server implemented in Python.
+This project includes an Open Charge Point Protocol (OCPP) version 2.0.1 mock server implemented in Python.
 
 ## Prerequisites
 
-This project requires Python 3.7+ and the following Python packages:
+This project requires Python 3.7+ and [poetry](https://python-poetry.org/) to install the required packages:
 
-- `websockets`
-- `ocpp`
-
-You can install these packages using pip:
-```
-pip install websockets ocpp
+```shell
+poetry install
 ```
 
 ## Running the Server
 
 To start the server, run the `server.py` script:
 
-```
+```shell
 python server.py
 ```
 
@@ -32,9 +28,23 @@ 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 scripts don't execute full OCPP adherence and it is advised not to use them in a production environment without additional development.
+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.
 
 For reference:
 https://github.com/mobilityhouse/ocpp