ngsildclient documentation#

Welcome to the ngsildclient documentation, where you can learn about ngsildclient and explore its features.

ngsildclient is a Python NGSI-LD client implementation.

NGSI-LD has been standardized by the ETSI and is widely used in the Fiware ecosystem.
ngsildclient is based on the NGSI-LD API ETSI Specification [ETSI_GS_CIM_009_V1.5.1].

Project Goals#

The ngsildclient Python library has two main objectives.

  1. Build NGSI-LD compliant entities

    The task of writing large NGSI-LD compliant entities using JSON is tedious, error-prone and results in a significant amount of code.
    ngsilclient provides primitives to build and manipulate NGSI-LD entities without effort, in respect with the ETSI specifications.

  2. Wrap the NGSI-LD API

    As a Python NGSI-LD client it allows to interact with a broker by sending and retrieving NGSI-LD entities.
    As of v0.1.8 it supports a subset of the API.

Indices and tables#

ETSI_GS_CIM_009_V1.5.1

ETSI Group Specification Context Information Management (CIM) NGSI-LD API v1.5.1 2021-11