Provenance

Extract provenance information from the repository.

Activities

class renku.core.models.provenance.activity.Activity(*, agents: Optional[List[Union[renku.core.models.provenance.agent.Person, renku.core.models.provenance.agent.SoftwareAgent]]] = None, annotations: Optional[List[renku.core.models.provenance.annotation.Annotation]] = None, association: Optional[renku.core.models.provenance.activity.Association] = None, ended_at_time: Optional[datetime.datetime] = None, generations: Optional[List[renku.core.models.provenance.activity.Generation]] = None, id: str, invalidations: Optional[List[renku.core.models.entity.Entity]] = None, parameters: Optional[List[Union[renku.core.models.provenance.parameter.PathParameterValue, renku.core.models.provenance.parameter.VariableParameterValue]]] = None, started_at_time: Optional[datetime.datetime] = None, usages: Optional[List[renku.core.models.provenance.activity.Usage]] = None)

Represent an activity in the repository.

freeze()

Set immutable property.

classmethod from_plan(plan: renku.core.models.workflow.plan.Plan, client_dispatcher: renku.core.management.interface.client_dispatcher.IClientDispatcher, started_at_time: datetime.datetime, ended_at_time: datetime.datetime, annotations: List[renku.core.models.provenance.annotation.Annotation], commit=None, update_commits=False)

Convert a Plan to a Activity.

static generate_id() → str

Generate an identifier for an activity.

property immutable

Return if object is immutable.

reassign_oid()

Reassign oid (after assigning a new identifier for example).

Entities

class renku.core.models.entity.Entity(*, checksum: str, id: Optional[str] = None, path: Union[pathlib.Path, str], **kwargs)

Represent a file.

classmethod from_revision(client, path: Union[pathlib.Path, str], revision: Optional[str] = None) → renku.core.models.entity.Entity

Return dependency from given path and revision.

static generate_id(checksum: str, path: Union[pathlib.Path, str]) → str

Generate an Entity identifier.

classmethod get_directory_members(client, revision, absolute_path: pathlib.Path) → List[renku.core.models.entity.Entity]

Return first-level files/directories in a directory.

classmethod make_instance(instance)

Return a cached instance if available otherwise create an instance from the given parameters.

class renku.core.models.entity.Collection(*, checksum: str, id: Optional[str] = None, path: Union[pathlib.Path, str], members: Optional[List[renku.core.models.entity.Entity]] = None)

Represent a directory with files.

classmethod from_revision(client, path: Union[pathlib.Path, str], revision: Optional[str] = None) → renku.core.models.entity.Entity

Return dependency from given path and revision.

static generate_id(checksum: str, path: Union[pathlib.Path, str]) → str

Generate an Entity identifier.

classmethod get_directory_members(client, revision, absolute_path: pathlib.Path) → List[renku.core.models.entity.Entity]

Return first-level files/directories in a directory.

classmethod make_instance(instance)

Return a cached instance if available otherwise create an instance from the given parameters.

Agents

class renku.core.models.provenance.agent.Person(*, affiliation: Optional[str] = None, alternate_name: Optional[str] = None, email: Optional[str] = None, id: Optional[str] = None, name: str)

Represent a person.

classmethod from_client(client) → Optional[renku.core.models.provenance.agent.Person]

Create an instance from a Renku project repo.

classmethod from_commit(commit)

Create an instance from a Git commit.

classmethod from_dict(data)

Create and instance from a dictionary.

classmethod from_git(git)

Create an instance from a Git repo.

classmethod from_jsonld(data)

Create an instance from JSON-LD data.

classmethod from_string(string)

Create an instance from a ‘Name <email>’ string.

property full_identity

Return name, email, and affiliation.

static generate_id(email, full_identity)

Generate identifier for Person.

static get_full_identity(email, affiliation, name)

Return name, email, and affiliation.

classmethod make_instance(**kwargs)

Instantiate from the given parameters.

property short_name

Gives full name in short form.

class renku.core.models.provenance.agent.SoftwareAgent(*, id: str, name: str, **kwargs)

Represent executed software.

classmethod from_commit(commit)

Create an instance from a Git commit.

classmethod make_instance(**kwargs)

Instantiate from the given parameters.

Annotations

class renku.core.models.provenance.annotation.Annotation(*, id: str, body=None, source=None)

Represents a custom annotation for a research object.