Low-level API

This API is built on top of REST API endpoints exposed by Renku services.

Warning

Renku services are currently in beta preview status and they are subject to change in forseenable future.

HTTP clients for Renku platform.

class renku.api.LocalClient(path=<function default_path>, renku_home='.renku', parent=None, use_external_storage=True, datadir='data')[source]

A low-level client for communicating with a local Renku repository.

Example:

>>> import renku
>>> client = renku.LocalClient('.')

Datasets

Client for handling datasets.

class renku.api.datasets.DatasetsApiMixin(datadir='data')[source]

Client for handling datasets.

DATASETS = 'datasets'

Directory for storing dataset metadata in Renku.

add_data_to_dataset(dataset, url, git=False, force=False, **kwargs)[source]

Import the data into the data directory.

datadir = None

Define a name of the folder for storing datasets.

datasets

Return mapping from path to dataset.

get_relative_url(url)[source]

Determine if the repo url should be relative.

renku_datasets_path

Return a Path instance of Renku dataset metadata folder.

with_dataset(name=None)[source]

Yield an editable metadata object for a dataset.

renku.api.datasets.check_for_git_repo(url)[source]

Check if a url points to a git repository.

Repository

Client for handling a local repository.

class renku.api.repository.PathMixin(path=<function default_path>)[source]

Define a default path attribute.

class renku.api.repository.RepositoryApiMixin(renku_home='.renku', parent=None)[source]

Client for handling a local repository.

LOCK_SUFFIX = '.lock'

Default suffix for Renku lock file.

METADATA = 'metadata.yml'

Default name of Renku config file.

WORKFLOW = 'workflow'

Directory for storing workflow in Renku.

cwl_prefix[source]

Return a CWL prefix.

find_previous_commit(paths, revision='HEAD')[source]

Return a previous commit for a given path.

init_repository(name=None, force=False)[source]

Initialize a local Renku repository.

is_cwl(path)[source]

Check if the path is a valid CWL file.

lock

Create a Renku config lock.

parent = None

Store a pointer to the parent repository.

project[source]

Return FOAF/PROV representation of the project.

renku_home = None

Define a name of the Renku folder (default: .renku).

renku_metadata_path

Return a Path instance of Renku metadata file.

renku_path = None

Store a Path instance of the Renku folder.

resolve_in_submodules(commit, path)[source]

Resolve filename in submodules.

subclients(parent_commit)[source]

Return mapping from submodule to client.

submodules[source]

Return list of submodules it belongs to.

with_metadata()[source]

Yield an editable metadata object.

with_workflow_storage()[source]

Yield a workflow storage.

workflow_names[source]

Return index of workflow names.

workflow_path

Return a Path instance of the workflow folder.

renku.api.repository.default_path()[source]

Return default repository path.