Code documentation of the Django base views

The basic premise is that lizard-structure only shows a data source’s structure. There are no edit actions, so no POST/PUT/DELETE: only GET.

There are several basic ways to deal with naming the views. Especially when you also want POST/PUT/DELETE, having both ObjectList and ObjectDetail makes sense. But we don’t need that. What’s most interesting are the lists, these are also often the most effective. You don’t want to have to grab handfuls of URLs before you can render a page. You want the most useful data right away. So on an Data source page, you want a list of projects. On a Project page, a list of layers. And so on.

We deemed it more useful to call the view with the list of projects the data source view, though. A data source is a list of projects, so it makes sense that way.

But: a project also has information on itself, as has a project, etc.

class lizard_structure.views.DataSourceView(**kwargs)[source]

Information about the data source itself and its list of projects.

Use this to discover the projects you can show in your user interface. The result is a dictionary with the following items:

about_ourselves
Metadata about ourselves, like the software version that generated it. Do not depend on the actual items in here, just display them when desired as background information.
projects
The list of available projects. A project is a collection of layers you can show on a map or in an overview.
about_ourselves[source]

Return metadata about ourselves.

our_name_and_version[source]

Return name version number of our package.

projects[source]

Return maptree categories.

Maptree categories are usable as root objects of lizard pages.

class lizard_structure.views.FeatureView(**kwargs)[source]

Information about the feature and most importantly its representations.

class lizard_structure.views.LayerView(**kwargs)[source]

Information about the layer and its list of features.

class lizard_structure.views.ProjectView(**kwargs)[source]

Information about the project and its list of layers.

Project Versions

Previous topic

Introducing the four core Lizard concepts

Next topic

Project documentation

This Page