list_documents#

dscat.queries.list_documents(cat, dataset, version, all_versions)[source]#

List non-dictionary documentation files in scope.

Parameters:

  • cat (dscat.index.Catalogue) – Open catalogue to read from.

  • dataset (str or None) – Restrict to one dataset.

  • version (str or None) – Pin a version (needs dataset); the default scope is the latest.

  • all_versions (bool) – Cover every version instead of only the latest.

Returns:

Document rows with dataset, version, kind, title, and path.

Return type:

collections.abc.Sequence of sqlalchemy.engine.RowMapping