ckanapi_harvesters.reports.schemas package

Submodules

ckanapi_harvesters.reports.schemas.admin_report module

Detailed report on package resources: size, access rights and data format policy scores

class ckanapi_harvesters.reports.schemas.admin_report.AdminReportFooter(requests_count: int, time_elapsed_seconds: float)

Bases: OrderedDataClass

requests_count: int

time_elapsed_seconds: float

class ckanapi_harvesters.reports.schemas.admin_report.AdminReportGroupMetadata(group_name: str, group_title: str, package_count: int, users_count: int, users: collections.OrderedDict[str, ckanapi_harvesters.auxiliary.ckan_model.CkanCapacity])

Bases: OrderedDataClass

group_name: str

group_title: str

package_count: int

users: OrderedDict[str, CkanCapacity]

users_count: int

class ckanapi_harvesters.reports.schemas.admin_report.AdminReportHeader(title: str, date: datetime.datetime | None, timestamp: str, ckan_url: str, user: str | None, user_sysadmin: bool | None, package_selection: List[str] | str, public_packages: collections.OrderedDict[str, str] | None)

Bases: OrderedDataClass

ckan_url: str

date: datetime | None

package_selection: List[str] | str

public_packages: OrderedDict[str, str] | None

timestamp: str

title: str

user: str | None

user_sysadmin: bool | None

class ckanapi_harvesters.reports.schemas.admin_report.AdminReportOrganizationMetadata(organization_name: str, organization_title: str, package_count: int, users_count: int, users: collections.OrderedDict[str, ckanapi_harvesters.auxiliary.ckan_model.CkanCapacity])

Bases: OrderedDataClass

organization_name: str

organization_title: str

package_count: int

users: OrderedDict[str, CkanCapacity]

users_count: int

class ckanapi_harvesters.reports.schemas.admin_report.AdminReportPackageExtended(package_name: str, package_title: str, page_url: str, state: ckanapi_harvesters.auxiliary.ckan_model.CkanState, organization: str, version: str, license: str | None, license_domain: ckanapi_harvesters.auxiliary.ckan_model.CkanLicenseDomain | None, creator: str | None, author: str, maintainer: str, visibility: ckanapi_harvesters.auxiliary.ckan_model.CkanVisibility, metadata_modified: datetime.datetime, resource_count: int, tags: List[str], extras: collections.OrderedDict[str, str | None], users: collections.OrderedDict[str, ckanapi_harvesters.auxiliary.ckan_model.CkanCapacity] | str, groups: List[str], resources_modified: datetime.datetime, resources_metadata_modified: datetime.datetime, among_resources_filestore: int, among_resources_external: int, among_resources_datastore: int, filestore_total_size_mb: float, external_total_size_mb: float, datastore_total_size_mb: float, datastore_total_lines: int, data_format_policy_scores: ckanapi_harvesters.policies.data_format_policy_errors.ErrorCount, resources: List[ckanapi_harvesters.reports.schemas.admin_report.AdminReportResourceMetadata], policy_messages: List[ckanapi_harvesters.policies.data_format_policy_errors.DataPolicyError] | None)

Bases: AdminReportPackageSimple

among_resources_datastore: int

among_resources_external: int

among_resources_filestore: int

data_format_policy_scores: ErrorCount

datastore_total_lines: int

datastore_total_size_mb: float

external_total_size_mb: float

filestore_total_size_mb: float

policy_messages: List[DataPolicyError] | None

resources: List[AdminReportResourceMetadata]

resources_metadata_modified: datetime

resources_modified: datetime

to_dict(*, datetime_fcn: Callable[[datetime], Any] = None, float_round_fcn: Callable[[float], Any] = None, convert_ckan: bool = True) → OrderedDict

class ckanapi_harvesters.reports.schemas.admin_report.AdminReportPackageSimple(package_name: str, package_title: str, page_url: str, state: ckanapi_harvesters.auxiliary.ckan_model.CkanState, organization: str, version: str, license: str | None, license_domain: ckanapi_harvesters.auxiliary.ckan_model.CkanLicenseDomain | None, creator: str | None, author: str, maintainer: str, visibility: ckanapi_harvesters.auxiliary.ckan_model.CkanVisibility, metadata_modified: datetime.datetime, resource_count: int, tags: List[str], extras: collections.OrderedDict[str, str | None], users: collections.OrderedDict[str, ckanapi_harvesters.auxiliary.ckan_model.CkanCapacity] | str, groups: List[str])

Bases: OrderedDataClass

author: str

creator: str | None

extras: OrderedDict[str, str | None]

groups: List[str]

license: str | None

license_domain: CkanLicenseDomain | None

maintainer: str

metadata_modified: datetime

organization: str

package_name: str

package_title: str

page_url: str

resource_count: int

state: CkanState

tags: List[str]

to_dict(*, datetime_fcn: Callable[[datetime], Any] = None, float_round_fcn: Callable[[float], Any] = None, convert_ckan: bool = True) → OrderedDict

users: OrderedDict[str, CkanCapacity] | str

version: str

visibility: CkanVisibility

class ckanapi_harvesters.reports.schemas.admin_report.AdminReportResourceMetadata(resource_name: str, id: str, page_url: str, state: ckanapi_harvesters.auxiliary.ckan_model.CkanState, external_url: str, filestore_size_mb: float, external_size_mb: float, datastore_size_mb: float, datastore_active: bool, datastore_lines: int | None, date_modified: datetime.datetime | None, metadata_modified: datetime.datetime | None, datastore_aliases: List[str] | None)

Bases: OrderedDataClass

datastore_active: bool

datastore_aliases: List[str] | None

datastore_lines: int | None

datastore_size_mb: float

date_modified: datetime | None

external_size_mb: float

external_url: str

filestore_size_mb: float

id: str

metadata_modified: datetime | None

page_url: str

resource_name: str

state: CkanState

Bases: OrderedDataClass

footer: AdminReportFooter

groups: OrderedDict[str, AdminReportGroupMetadata] | None

header: AdminReportHeader

organizations: OrderedDict[str, AdminReportOrganizationMetadata] | None

packages: OrderedDict[str, AdminReportPackageSimple]

totals: AdminReportTotalsSimple

users: AdminReportUsersSection

class ckanapi_harvesters.reports.schemas.admin_report.AdminReportTotalsExtended(num_packages: int, total_resource_count: int, last_modified_metadata: datetime.datetime | None, total_filestore_size_mb: float, total_datastore_size_mb: float, total_external_size_mb: float, total_datastore_lines: int, among_resources_filestore: int, among_resources_external: int, among_resources_datastore: int, last_modified_data: datetime.datetime | None, total_policy_errors: ckanapi_harvesters.policies.data_format_policy_errors.ErrorCount)

Bases: AdminReportTotalsSimple

among_resources_datastore: int

among_resources_external: int

among_resources_filestore: int

last_modified_data: datetime | None

total_datastore_lines: int

total_datastore_size_mb: float

total_external_size_mb: float

total_filestore_size_mb: float

total_policy_errors: ErrorCount

class ckanapi_harvesters.reports.schemas.admin_report.AdminReportTotalsSimple(num_packages: int, total_resource_count: int, last_modified_metadata: datetime.datetime | None)

Bases: OrderedDataClass

last_modified_metadata: datetime | None

num_packages: int

total_resource_count: int

class ckanapi_harvesters.reports.schemas.admin_report.AdminReportUserMetadata(user_name: str, fullname: str, email: str | None, last_active: datetime.datetime, organizations: collections.OrderedDict[str, ckanapi_harvesters.auxiliary.ckan_model.CkanCapacity], groups: collections.OrderedDict[str, ckanapi_harvesters.auxiliary.ckan_model.CkanCapacity])

Bases: OrderedDataClass

email: str | None

fullname: str

groups: OrderedDict[str, CkanCapacity]

last_active: datetime

organizations: OrderedDict[str, CkanCapacity]

user_name: str

class ckanapi_harvesters.reports.schemas.admin_report.AdminReportUsersSection(sysadmins: collections.OrderedDict[str, ckanapi_harvesters.reports.schemas.admin_report.AdminReportUserMetadata], other: collections.OrderedDict[str, ckanapi_harvesters.reports.schemas.admin_report.AdminReportUserMetadata])

Bases: OrderedDataClass

other: OrderedDict[str, AdminReportUserMetadata]

sysadmins: OrderedDict[str, AdminReportUserMetadata]

class ckanapi_harvesters.reports.schemas.admin_report.OrderedDataClass

Bases: ABC

to_dict(*, datetime_fcn: Callable[[datetime], Any] = None, float_round_fcn: Callable[[float], Any] = None, convert_ckan: bool = True) → OrderedDict

Module contents

Schemas used to make reports on the CKAN database.