To use the pyLDAPI module, a set of requirements must be met for the tool to work correctly.

Jinja2 Templates


A members.html template is required to deliver a register of items.


An alternates.html template is required to deliver an alternates view of a register or instance of a class. Alternatively, you can specify a different template for the alternates view by passing an optional argument to the pyldapi.Renderer.__init__() as alternates_template=.


A template for each class item in the dataset is required to render a class item.

Example: The online LD API for the Geofabric at is exposing three class types, Catchment, River Region and Drainage Division. You can see in the image below showcasing the templates used for this API.



These are of course not the only Jinja2 templates that you will have. Other ones may include something like the API’s home page, about page, etc. You can also see that there are more than one template for a specific class type in the image above. These different templates with geof and hyf are the different views for the specific class item. See View for more information.

See also

See also the template information under the Jinja2 Templates section of the documentation for more information in regards to what variables are required to pass in to the required templates.