Skip to content
Snippets Groups Projects
Verified Commit a2a81822 authored by Olivier Benz's avatar Olivier Benz
Browse files

Update README, Add code of coduct

parent 5cf753db
No related branches found
No related tags found
No related merge requests found
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for
moderation decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail
address, posting via an official social media account, or acting as an
appointed representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
<info@b-data.ch>. All complaints will be reviewed and investigated
promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
<a href="https://liberapay.com/benz0li/donate"><img src="https://liberapay.com/assets/widgets/donate.svg" alt="Donate using Liberapay" height="20"></a> <a href="https://benz0li.b-data.io/donate?project=1"><img src="https://benz0li.b-data.io/donate/static/donate-with-fosspay.png" alt="Donate with fosspay"></a>
[![minimal-readme compliant](https://img.shields.io/badge/readme%20style-minimal-brightgreen.svg)](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/minimal-readme.md) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) <a href="https://liberapay.com/benz0li/donate"><img src="https://liberapay.com/assets/widgets/donate.svg" alt="Donate using Liberapay" height="20"></a> <a href="https://benz0li.b-data.io/donate?project=1"><img src="https://benz0li.b-data.io/donate/static/donate-with-fosspay.png" alt="Donate with fosspay"></a>
# Docker stack
# JupyterLab R docker stack
Pre-built multi-arch (`linux/amd64`, `linux/arm64/v8`) docker images:
* `registry.gitlab.b-data.ch/jupyterlab/r/base`
* `registry.gitlab.b-data.ch/jupyterlab/r/tidyverse`
* `registry.gitlab.b-data.ch/jupyterlab/r/verse`
* `registry.gitlab.b-data.ch/jupyterlab/r/geospatial`
Images considered stable for R versions ≥ 4.2.0.
:point_right: The current state may eventually be backported to versions ≥
4.0.4.
**Features**
* **JupyterLab**: A web-based interactive development environment for Jupyter
notebooks, code, and data. The docker images include
* **code-server**: VS Code in the browser without MS
branding/telemetry/licensing.
* **Git**: A distributed version-control system for tracking changes in
source code.
* **Pandoc**: A universal markup converter.
* **Python**: An interpreted, object-oriented, high-level programming
language with dynamic semantics.
* **Quarto**: An open-source scientific and technical publishing system
built on Pandoc.
:information_source: verse image, amd64 only
* **R**: A language and environment for statistical computing and
graphics.
* **TinyTeX**: A lightweight, cross-platform, portable, and
easy-to-maintain LaTeX distribution based on TeX Live.
:information_source: verse image
* **Zsh**: A shell designed for interactive use, although it is also a
powerful scripting language.
The following extensions are pre-installed for **code-server**:
* [.gitignore Generator](https://github.com/piotrpalarz/vscode-gitignore-generator)
* [Git Graph](https://open-vsx.org/extension/mhutchie/git-graph)
* [GitLab Workflow](https://open-vsx.org/extension/GitLab/gitlab-workflow)
* [GitLens — Git supercharged](https://open-vsx.org/extension/eamodio/gitlens)
* [Excel Viewer](https://open-vsx.org/extension/GrapeCity/gc-excelviewer)
* [Jupyter](https://open-vsx.org/extension/ms-toolsai/jupyter)
* [LaTeX Workshop](https://open-vsx.org/extension/James-Yu/latex-workshop)
:information_source: verse image
* [Path Intellisense](https://open-vsx.org/extension/christian-kohler/path-intellisense)
* [Project Manager](https://open-vsx.org/extension/alefragnani/project-manager)
* [Python](https://open-vsx.org/extension/ms-python/python)
* [Quarto](https://open-vsx.org/extension/quarto/quarto)
:information_source: verse image, amd64 only
* [R](https://open-vsx.org/extension/Ikuyadeu/r)
* [YAML](https://open-vsx.org/extension/redhat/vscode-yaml)
## Table of Contents
* [Prerequisites](#prerequisites)
* [Install](#install)
* [Usage](#usage)
* [Similar projects](#similar-projects)
* [Contributing](#contributing)
* [License](#license)
## Prerequisites
This projects requires an installation of docker.
## Install
To install docker, follow the instructions for your platform:
* [Install Docker Engine | Docker Documentation > Supported platforms](https://docs.docker.com/engine/install/#supported-platforms)
* [Post-installation steps for Linux](https://docs.docker.com/engine/install/linux-postinstall/)
## Usage
### Build image (base)
latest:
```bash
cd base && docker build \
--build-arg R_VERSION=4.2.1 \
-t jupyterlab-r-base \
-f latest.Dockerfile .
```
version:
```bash
cd base && docker build \
-t jupyterlab-r-base:<major>.<minor>.<patch> \
-f <major>.<minor>.<patch>.Dockerfile .
```
For `<major>.<minor>.<patch>``4.2.0`.
### Run container
self built:
```bash
docker run --rm -ti jupyterlab-r-base[:<major>.<minor>.<patch>]
```
from the project's GitLab Container Registries:
* [jupyterlab/r/base](https://gitlab.b-data.ch/jupyterlab/r/base/container_registry)
```bash
docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan registry.gitlab.b-data.ch/jupyterlab/r/base[:<major>[.<minor>[.<patch>]]]
```
* [jupyterlab/r/tidyverse](https://gitlab.b-data.ch/jupyterlab/r/tidyverse/container_registry)
```bash
docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan registry.gitlab.b-data.ch/jupyterlab/r/tidyverse[:<major>[.<minor>[.<patch>]]]
```
* [jupyterlab/r/verse](https://gitlab.b-data.ch/jupyterlab/r/verse/container_registry)
```bash
docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan registry.gitlab.b-data.ch/jupyterlab/r/verse[:<major>[.<minor>[.<patch>]]]
```
* [jupyterlab/r/geospatial](https://gitlab.b-data.ch/jupyterlab/r/geospatial/container_registry)
```bash
docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan registry.gitlab.b-data.ch/jupyterlab/r/geospatial[:<major>[.<minor>[.<patch>]]]
```
The use of the `-v` flag in the command mounts the current working directory on
the host (`$PWD` in the example command) as `/home/jovyan` in the container.
The server logs appear in the terminal.
## Similar projects
* [jupyter/docker-stacks](https://github.com/jupyter/docker-stacks)
* [rocker-org/rocker-versioned2](https://github.com/rocker-org/rocker-versioned2)
**What makes this project different:**
1. Base image: [Debian](https://hub.docker.com/_/debian) instead of
[Ubuntu](https://hub.docker.com/_/ubuntu)
1. IDE: [code-server](https://github.com/coder/code-server) instead of
[RStudio](https://github.com/rstudio/rstudio)
1. Just Python – no [Conda](https://github.com/conda/conda) /
[Mamba](https://github.com/mamba-org/mamba)
## Contributing
PRs accepted.
This project follows the
[Contributor Covenant](https://www.contributor-covenant.org)
[Code of Conduct](CODE_OF_CONDUCT.md).
## License
[MIT](LICENSE) © 2020 b-data GmbH
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment