Skip to content

Installation

Installation

Install the module with pip:

pip install reemote

Installing the ReST API

The optional ReST API can be installed with pipx.

python3 -m venv myenv
source myenv/bin/activate
pipx install reemote

Starting the ReST API server

The server runs on the local host.

reemote --port=8001

Parameter, such as the port number, are passed to uvicorn except:

  • --inventory: The inventory file path (optional).
  • --logging: The logging file path (optional).

When the server is running the API documentation can be found at http://localhost:8001/redoc and the Swagger UI can be found a http://localhost:8001/docs.