test(ocpp-server): add task to run server

[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 cd6d2e5da178482df7263d6f7b19ac56a3cfd28e..bb5d5b17ff3eeac70e204f3732b44eaec6e0c966 100644 (file)
--- a/tests/ocpp-server/README.md
+++ b/tests/ocpp-server/README.md
@@ -4,23 +4,18 @@ This project includes an Open Charge Point Protocol (OCPP) version 2.0.1 mock se
 
 ## Prerequisites
 
 
 ## 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:
 
 ```
 
 ## Running the Server
 
 To start the server, run the `server.py` script:
 

-```
-python server.py
+```shell
+poetry run task server

 ```
 
 The server will start listening for connections on port 9000.
 ```
 
 The server will start listening for connections on port 9000.


@@ -33,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.
 
 
 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
 
 ## 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
 
 For reference:
 https://github.com/mobilityhouse/ocpp