shinto.mimir package

Submodules

shinto.mimir.base module

Internal functions for Mimir.

shinto.mimir.base.get_default_user(connection: Connection) → dict

Get the default user.

shinto.mimir.base.get_default_user_id(connection: Connection) → UUID

Get the default user ID.

shinto.mimir.config module

Module for managing configs in Mimir.

shinto.mimir.config.create_config(connection: Connection, action_by: UUID, name: str, data: dict, action_info: dict | None = None) → dict

Create a config.

shinto.mimir.config.delete_config(connection: Connection, action_by: UUID, config_id: UUID, action_info: dict | None = None) → dict

Delete a config. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.config.get_config_by_id(connection: Connection, action_by: UUID, config_id: UUID, timestamp: datetime | str | None = None) → dict

Get a config by ID. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.config.get_config_by_name(connection: Connection, action_by: UUID, config_name: str, timestamp: datetime | str | None = None) → dict

Get a config by name. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.config.get_config_history(connection: Connection, action_by: UUID, config_id: UUID) → list[dict]

Get the history of a config.

shinto.mimir.config.get_config_list(connection: Connection, action_by: UUID, timestamp: datetime | str | None = None) → list[dict]

Get a list of taxonomies. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.config.update_config(connection: Connection, action_by: UUID, config_id: UUID, name: str | None = None, data: dict | None = None, action_info: dict | None = None) → dict

Update a config. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.marker module

Marker management functions for Shinto Mimir.

shinto.mimir.marker.create_marker(connection: Connection, action_by: UUID, name: str, marked_timestamp: datetime | str | None = None, action_info: dict | None = None) → dict

Create a marker.

shinto.mimir.marker.delete_marker(connection: Connection, action_by: UUID, marker_id: UUID, action_info: dict | None = None) → dict

Delete a marker. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.marker.get_marker_by_id(connection: Connection, action_by: UUID, marker_id: UUID, timestamp: datetime | str | None = None) → dict

Get a marker by ID. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.marker.get_marker_by_name(connection: Connection, action_by: UUID, marker_name: str, timestamp: datetime | str | None = None) → dict

Get a marker by name. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.marker.get_marker_history(connection: Connection, action_by: UUID, marker_id: UUID) → list[dict]

Get the history of a marker.

shinto.mimir.marker.get_marker_list(connection: Connection, action_by: UUID, timestamp: datetime | str | None = None) → list[dict]

Get a list of taxonomies. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.marker.update_marker(connection: Connection, action_by: UUID, marker_id: UUID, name: str | None = None, marked_timestamp: datetime | str | None = None, action_info: dict | None = None) → dict

Update a marker. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.mimir module

Internal functions for Mimir.

shinto.mimir.mimir.dump_database_to_json(connection: Connection, include_base: bool = True, include_audit: bool = True) → str

Dump the entire database as JSON.

shinto.mimir.mimir.get_mimir_version(connection: Connection) → str

Get the Mimir version.

shinto.mimir.mimir.load_table(connection: Connection, table_name: str, data: list[dict], update_action_by: bool = False) → None

Load JSON data into a table.

shinto.mimir.project module

Project management functions for Shinto Mimir.

shinto.mimir.project.create_project(connection: Connection, action_by: UUID, data: dict | None, action_info: dict | None = None) → dict

Create a project.

shinto.mimir.project.delete_project(connection: Connection, action_by: UUID, project_id: UUID, action_info: dict | None = None) → dict

Delete a project. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.project.force_project_record(connection: Connection, action_by: UUID, action: str, project_id: UUID, timestamp: datetime | str, data: dict, action_info: dict | None = None, taxonomy_id: UUID | None = None, taxonomy_timestamp: datetime | str | None = None) → dict

Force create a project with a specific ID and timestamp.

shinto.mimir.project.get_project_by_id(connection: Connection, action_by: UUID, project_id: UUID, timestamp: datetime | str | None = None) → dict

Get a project by ID. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.project.get_project_history(connection: Connection, action_by: UUID, project_id: UUID) → list[dict]

Get the history of a project.

shinto.mimir.project.get_project_list(connection: Connection, action_by: UUID, timestamp: datetime | str | None = None) → list[dict]

Get a list. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.project.update_project(connection: Connection, action_by: UUID, project_id: UUID, data: dict | None = None, action_info: dict | None = None) → dict

Update a project. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.role module

shinto.mimir.setting module

Project management functions for Shinto Mimir.

shinto.mimir.setting.create_project(connection: Connection, action_by: UUID, data: dict | None, action_info: dict | None = None) → dict

Create a project.

shinto.mimir.setting.delete_project(connection: Connection, action_by: UUID, project_id: UUID, action_info: dict | None = None) → dict

Delete a project. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.setting.force_project_record(connection: Connection, action_by: UUID, action: str, project_id: UUID, timestamp: datetime | str, data: dict, action_info: dict | None = None, taxonomy_id: UUID | None = None, taxonomy_timestamp: datetime | str | None = None) → dict

Force create a project with a specific ID and timestamp.

shinto.mimir.setting.get_project_by_id(connection: Connection, action_by: UUID, project_id: UUID, timestamp: datetime | str | None = None) → dict

Get a project by ID. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.setting.get_project_history(connection: Connection, action_by: UUID, project_id: UUID) → list[dict]

Get the history of a project.

shinto.mimir.setting.get_project_list(connection: Connection, action_by: UUID, timestamp: datetime | str | None = None) → list[dict]

Get a list. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.setting.update_project(connection: Connection, action_by: UUID, project_id: UUID, data: dict | None = None, action_info: dict | None = None) → dict

Update a project. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.system_defaults module

shinto.mimir.taxonomy module

shinto.mimir.taxonomy.create_taxonomy(connection: Connection, action_by: UUID, name: str, data: dict | None, action_info: dict | None = None) → dict

Create a taxonomy.

shinto.mimir.taxonomy.delete_taxonomy(connection: Connection, action_by: UUID, taxonomy_id: UUID, action_info: dict | None = None) → dict

Delete a taxonomy. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.taxonomy.get_taxonomy_by_id(connection: Connection, action_by: UUID, taxonomy_id: UUID, timestamp: datetime | str | None = None) → dict

Get a taxonomy by ID. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.taxonomy.get_taxonomy_by_name(connection: Connection, action_by: UUID, taxonomy_name: str, timestamp: datetime | str | None = None) → dict

Get a taxonomy by name. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.taxonomy.get_taxonomy_history(connection: Connection, action_by: UUID, taxonomy_id: UUID) → list[dict]

Get the history of a taxonomy.

shinto.mimir.taxonomy.get_taxonomy_list(connection: Connection, action_by: UUID, timestamp: datetime | str | None = None) → list[dict]

Get a list of taxonomies. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.taxonomy.update_taxonomy(connection: Connection, action_by: UUID, taxonomy_id: UUID, name: str | None = None, data: dict | None = None, action_info: dict | None = None) → dict

Update a taxonomy. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.transformation module

Module for managing transformations in the Mimir data catalog.

shinto.mimir.transformation.create_transformation(connection: Connection, action_by: UUID, name: str, data: dict, action_info: dict | None = None) → dict

Create a transformation.

shinto.mimir.transformation.delete_transformation(connection: Connection, action_by: UUID, transformation_id: UUID, action_info: dict | None = None) → dict

Delete a transformation. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.transformation.get_transformation_by_id(connection: Connection, action_by: UUID, transformation_id: UUID, timestamp: datetime | str | None = None) → dict

Get a transformation by ID. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.transformation.get_transformation_by_name(connection: Connection, action_by: UUID, transformation_name: str, timestamp: datetime | str | None = None) → dict

Get a transformation by name. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.transformation.get_transformation_history(connection: Connection, action_by: UUID, transformation_id: UUID) → list[dict]

Get the history of a transformation.

shinto.mimir.transformation.get_transformation_list(connection: Connection, action_by: UUID, timestamp: datetime | str | None = None) → list[dict]

Get a list. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.transformation.update_transformation(connection: Connection, action_by: UUID, transformation_id: UUID, name: str | None = None, data: dict | None = None, action_info: dict | None = None) → dict

Update a transformation. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.user module

Module for managing users in Mimir.

shinto.mimir.user.create_user(connection: Connection, action_by: UUID, name: str, data: dict, action_info: dict | None = None) → dict

Create a user.

shinto.mimir.user.delete_user(connection: Connection, action_by: UUID, user_id: UUID, action_info: dict | None = None) → dict

Delete a user. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.user.get_user_by_id(connection: Connection, action_by: UUID, user_id: UUID, timestamp: datetime | str | None = None) → dict

Get a user by ID. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.user.get_user_by_name(connection: Connection, action_by: UUID, user_name: str, timestamp: datetime | str | None = None) → dict

Get a user by name. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.user.get_user_history(connection: Connection, action_by: UUID, user_id: UUID) → list[dict]

Get the history of a user.

shinto.mimir.user.get_user_list(connection: Connection, action_by: UUID, timestamp: datetime | str | None = None) → list[dict]

Get a list. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.user.update_user(connection: Connection, action_by: UUID, user_id: UUID, name: str | None = None, data: dict | None = None, action_info: dict | None = None) → dict

Update a user. Accepts timestamp as datetime, ISO 8601 string, or None.

shinto.mimir.user_pending module

Module contents

shinto.mimir.dump_database_to_json(connection: Connection, include_base: bool = True, include_audit: bool = True) → str

Dump the entire database as JSON.

shinto.mimir.get_default_user(connection: Connection) → dict

Get the default user.

shinto.mimir.get_default_user_id(connection: Connection) → UUID

Get the default user ID.

shinto.mimir.get_mimir_version(connection: Connection) → str

Get the Mimir version.

shinto.mimir.load_table(connection: Connection, table_name: str, data: list[dict], update_action_by: bool = False) → None

Load JSON data into a table.