Provenance¶
Extract provenance information from the repository.
Activities¶
-
class
renku.core.models.provenance.activities.
Activity
(*, commit=None, client=None, path=None, label=NOTHING, project: renku.core.models.projects.Project = None, id=None, message=NOTHING, was_informed_by=NOTHING, part_of=None, generated=None, invalidated=None, influenced=NOTHING, started_at_time=NOTHING, ended_at_time=NOTHING, agents=NOTHING)[source]¶ Represent an activity in the repository.
Method generated by attrs for class Activity.
-
default_label
()¶ Generate a default label.
-
default_reference
()¶ Create a default reference path.
-
classmethod
from_jsonld
(data, client=None, commit=None)[source]¶ Create an instance from JSON-LD data.
-
nodes
¶ Return topologically sorted nodes.
-
parents
¶ Return parent commits.
-
paths
¶ Return all paths in the commit.
-
removed_paths
¶ Return all paths removed in the commit.
-
submodules
¶ Proxy to client submodules.
-
-
class
renku.core.models.provenance.activities.
ProcessRun
(*, commit=None, client=None, path=None, label=NOTHING, project: renku.core.models.projects.Project = None, id=None, message=NOTHING, was_informed_by=NOTHING, part_of=None, invalidated=None, influenced=NOTHING, started_at_time=NOTHING, ended_at_time=NOTHING, agents=NOTHING, generated=None, association=None, annotations=None, qualified_usage=None)[source]¶ A process run is a particular execution of a Process description.
Method generated by attrs for class ProcessRun.
-
default_agents
()¶ Set person agent to be the author of the commit.
-
default_ended_at_time
()¶ Configure calculated properties.
-
default_id
()¶ Configure calculated ID.
-
default_influenced
()¶ Calculate default values.
-
default_invalidated
()¶ Entities invalidated by this Action.
-
default_label
()¶ Generate a default label.
-
default_message
()¶ Generate a default message.
-
default_reference
()¶ Create a default reference path.
-
default_started_at_time
()¶ Configure calculated properties.
-
default_was_informed_by
()¶ List parent actions.
-
classmethod
from_jsonld
(data, client=None, commit=None)[source]¶ Create an instance from JSON-LD data.
-
classmethod
from_run
(run, client, path, commit=None, subprocess_index=None, update_commits=False)[source]¶ Convert a
Run
to aProcessRun
.
-
classmethod
from_yaml
(path, client=None, commit=None)¶ Return an instance from a YAML file.
-
classmethod
generate_id
(commitsha)¶ Calculate action ID.
-
get_output_paths
()¶ Gets all output paths generated by this run.
-
nodes
¶ Return topologically sorted nodes.
-
parents
¶ Return parent commits.
-
paths
¶ Return all paths in the commit.
-
removed_paths
¶ Return all paths removed in the commit.
-
submodules
¶ Proxy to client submodules.
-
-
class
renku.core.models.provenance.activities.
WorkflowRun
(*, commit=None, client=None, path=None, label=NOTHING, project: renku.core.models.projects.Project = None, id=None, message=NOTHING, was_informed_by=NOTHING, part_of=None, invalidated=None, influenced=NOTHING, started_at_time=NOTHING, ended_at_time=NOTHING, agents=NOTHING, generated=None, association=None, annotations=None, qualified_usage=None, processes=NOTHING)[source]¶ A workflow run typically contains several subprocesses.
Method generated by attrs for class WorkflowRun.
-
add_annotations
(annotations)¶ Adds annotations from an external tool.
-
default_agents
()¶ Set person agent to be the author of the commit.
-
default_ended_at_time
()¶ Configure calculated properties.
-
default_generated
()¶ Create default
generated
.
-
default_id
()¶ Configure calculated ID.
-
default_influenced
()¶ Calculate default values.
-
default_invalidated
()¶ Entities invalidated by this Action.
-
default_label
()¶ Generate a default label.
-
default_message
()¶ Generate a default message.
-
default_reference
()¶ Create a default reference path.
-
default_started_at_time
()¶ Configure calculated properties.
-
default_was_informed_by
()¶ List parent actions.
-
classmethod
from_jsonld
(data, client=None, commit=None)[source]¶ Create an instance from JSON-LD data.
-
classmethod
from_run
(run, client, path, commit=None, update_commits=False)[source]¶ Convert a
Run
to aWorkflowRun
.
-
classmethod
from_yaml
(path, client=None, commit=None)¶ Return an instance from a YAML file.
-
classmethod
generate_id
(commitsha)¶ Calculate action ID.
-
get_output_paths
()¶ Gets all output paths generated by this run.
-
nodes
¶ Yield all graph nodes.
-
parents
¶ Return parent commits.
-
paths
¶ Return all paths in the commit.
-
plugin_annotations
()¶ Adds
Annotation``s from plugins to a ``ProcessRun
.
-
removed_paths
¶ Return all paths removed in the commit.
-
submodules
¶ Proxy to client submodules.
-
subprocesses
¶ Subprocesses of this
WorkflowRun
.
-
Entities¶
-
class
renku.core.models.entities.
Entity
(*, commit=None, client=None, path=None, id=None, label=NOTHING, project: renku.core.models.projects.Project = None, parent=None)[source]¶ Represent a data value or item.
Method generated by attrs for class Entity.
-
default_id
()¶ Configure calculated ID.
-
default_label
()¶ Generate a default label.
-
entities
¶ Yield itself.
-
classmethod
from_revision
(client, path, revision='HEAD', parent=None, find_previous=True, **kwargs)[source]¶ Return dependency from given path and revision.
-
parent
¶ Return the parent object.
-
submodules
¶ Proxy to client submodules.
-
-
class
renku.core.models.entities.
Collection
(*, commit=None, client=None, path=None, id=None, label=NOTHING, project: renku.core.models.projects.Project = None, parent=None, members=None)[source]¶ Represent a directory with files.
Method generated by attrs for class Collection.
-
default_id
()¶ Configure calculated ID.
-
default_label
()¶ Generate a default label.
-
entities
¶ Recursively return all files.
-
classmethod
from_revision
(client, path, revision='HEAD', parent=None, find_previous=True, **kwargs)¶ Return dependency from given path and revision.
-
parent
¶ Return the parent object.
-
submodules
¶ Proxy to client submodules.
-
Agents¶
-
class
renku.core.models.provenance.agents.
Person
(*, client=None, name, email=None, label=NOTHING, affiliation=None, alternate_name=None, id=None)[source]¶ Represent a person.
Method generated by attrs for class Person.
-
full_identity
¶ Return name, email, and affiliation.
-
short_name
¶ Gives full name in short form.
-
Relations¶
-
class
renku.core.models.provenance.qualified.
Usage
(*, entity, role=None, id=None)[source]¶ Represent a dependent path.
Method generated by attrs for class Usage.