Source code for solidipes_core_plugin.uploaders.renku

import re
import subprocess

from git.exc import InvalidGitRepositoryError
from solidipes.uploaders.uploader import Uploader
from solidipes.utils.utils import classproperty, get_git_repository, init_git_repository, optional_parameter

RENKU_REMOTE_NAME = "renku"
RENKU_TEMPLATE_NAMES = ["solidipes", "jtcam"]
RENKU_TEMPLATES_REPO = "https://gitlab.com/dcsm/renku-templates.git"




[docs]
class RenkulabUploader(Uploader):
    """Upload study to Renku. Initialises a git repository if necessary, and copies template files to the study root
    directory."""

    parser_key = "renku"

    def __init__(self, args):
        if args.template not in RENKU_TEMPLATE_NAMES:
            raise RuntimeError(f"invalid template {args.template}")



[docs]
    def upload(self, args):
        main(args)



    @optional_parameter
    def remote_url() -> str:
        """URL of the remote repository to push to. Not needed if the repository has already been uploaded to
        Renku."""
        pass

    @optional_parameter
    def template() -> str:
        "Template to use for the Renku repository"
        return "solidipes"

    @classproperty
    def report_widget_class(self):
        # from solidipes_core_plugin.reports.widgets.renku import RenkuPublish

        # return RenkuPublish
        return None






[docs]
def main(args):
    repo = init_git()

    if args.remote_url is not None:
        init_renku(args.template)
        add_remote(repo, args.remote_url)

    elif RENKU_REMOTE_NAME not in repo.remotes:
        print("Please provide a remote URL and template name.")
        return

    push(repo)

    session_link = get_session_link(repo)
    if session_link is not None:
        print(f"Session link: {session_link}")
    else:
        print("Please visit your hosting platform to start a session.")






[docs]
def init_git():
    """Initialize git and create initial commit if necessary"""

    try:
        repo = get_git_repository()

    except InvalidGitRepositoryError:
        repo = init_git_repository()
        repo.git.checkout("main", b=True)
        repo.git.add(all=True)
        repo.index.commit("initial commit")

    return repo






[docs]
def init_renku(template_name):
    subprocess.run([
        "renku",
        "init",
        "--template-source",
        RENKU_TEMPLATES_REPO,
        "--template-id",
        template_name,
    ])






[docs]
def add_remote(repo, remote_url):
    if RENKU_REMOTE_NAME in repo.remotes:
        repo.delete_remote(RENKU_REMOTE_NAME)
    repo.create_remote(RENKU_REMOTE_NAME, remote_url)






[docs]
def push(repo):
    print(f"Pushing to {repo.remotes[RENKU_REMOTE_NAME].url}")

    repo.git.push(RENKU_REMOTE_NAME)