From 08ec8a476fdfc2685ef7aaf413bb0447f9bbbfa2 Mon Sep 17 00:00:00 2001 From: Elisabetta Iavarone <18575092+elisabettai@users.noreply.github.com> Date: Mon, 15 Apr 2024 11:07:13 +0200 Subject: [PATCH] Adding missing cookiecuteer file --- README.md | 4 ++-- cookiecutter.json | 31 +++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 cookiecutter.json diff --git a/README.md b/README.md index ba9a9f6..9e38a47 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Template library to generate an [o²S²PARC compatible interactive service with the JupyterLab environment](https://docs.osparc.io/#/docs/study_setup/JupyterLabs?id=jupyterlab). In addition to the different JupyterLab "flavours" offered on o²S²PARC, you can use this library to create one with your favourite software and tools. -This library is pre-configured to easily build JuptyerLabs with Python, R or Julia and additional dependencies. Just choose the appropriate `base_image` when running the cookiecutter and follow the instructions in the `README.md`. +This library is pre-configured to easily build JupyterLabs with Python, R or Julia and additional dependencies. Just choose the appropriate `base_image` when running the cookiecutter and follow the instructions in the `README.md`. If you need to install other custom software, you can do so my selecting the custom image as `base_image`. @@ -12,7 +12,7 @@ If you need to install other custom software, you can do so my selecting the cus - Python3 - Python3-venv (recommended to work in a virtual environment) - [``cookiecutter``](https://python-package-generator.readthedocs.io/en/master/) -- [Docker](https://docs.docker.com/get-docker/) (if you wish to build and test the service locally) +- [``Docker``](https://docs.docker.com/get-docker/) (if you wish to build and test the service locally) ```console sudo apt-get update diff --git a/cookiecutter.json b/cookiecutter.json new file mode 100644 index 0000000..492287a --- /dev/null +++ b/cookiecutter.json @@ -0,0 +1,31 @@ +{ + "author_name": "YourName YourSurname", + "author_email": "Your address email (eq. you@example.com)", + "author_affiliation": "University of Anywhere, Department of something", + "contact_email": "{{ cookiecutter.author_email }}", + "project_name": "Name of the project", + "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '-') }}", + "project_package_name": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}", + "project_short_description": "{{ cookiecutter.project_name }}", + "docker_base": [ + "quay.io/jupyter/minimal-notebook:python-3.11", + "quay.io/jupyter/r-notebook:r-4.3.3", + "quay.io/jupyter/julia-notebook:julia-1.10.2", + "custom:special-image" + ], + "number_of_inputs": 4, + "number_of_outputs": 4, + "git_repo": [ + "local", + "github", + "gitlab" + ], + "git_username": "Yourusername", + "release_date": "{% now 'utc', '%Y' %}", + "version": "0.1.0", + "resources_CPU_nanoCPUs": 4000000000, + "resources_RAM_nanoBytes": 8000000000, + "_extensions": [ + "jinja2_time.TimeExtension" + ] +}