X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=tests%2Focpp-server%2FREADME.md;h=e2a8149c90de427c31db970401e41df9f69377e0;hb=ac96356cae880d404129e8cb56eeacdd712ea1d4;hp=cd6d2e5da178482df7263d6f7b19ac56a3cfd28e;hpb=dd4588bbff2b31d206367724d0aa843ecc7ef7c6;p=e-mobility-charging-stations-simulator.git diff --git a/tests/ocpp-server/README.md b/tests/ocpp-server/README.md index cd6d2e5d..e2a8149c 100644 --- a/tests/ocpp-server/README.md +++ b/tests/ocpp-server/README.md @@ -4,22 +4,17 @@ This project includes an Open Charge Point Protocol (OCPP) version 2.0.1 mock se ## 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 ``` @@ -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. +## 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