Commit 913479a2 authored by Cyril Matthey-Doret's avatar Cyril Matthey-Doret
Browse files

Update README.md

parent 30f624c7
Pipeline #313744 passed with stage
in 12 seconds
# jupytext-example
# Jupytext
## Introduction
[![launch - renku](https://img.shields.io/badge/launch-renku-2ea44f?logo=python)](https://renkulab.io/projects/best-practices/jupytext/sessions/new?autostart=1)
Here we showcase the use of jupytext using Renku.
Jupytext is a python package and jupyter plugin that allows to save notebooks to plain-text format, thereby solving common issues encountered when working with notebooks.
This is a Renku project - basically a git repository with some
bells and whistles. You'll find we have already created some
useful things like `data` and `notebooks` directories and
a `Dockerfile`.
This repository allows to try jupytex using Renku's interactive sessions. Click the badge above to get started.
## Working with the project
An extract from the official README is provided below. More information are available on the [official github repository](https://github.com/mwouts/jupytext).
The simplest way to start your project is right from the Renku
platform - just click on the `Environments` tab and start a new session.
This will start an interactive environment right in your browser.
## Introduction
To work with the project anywhere outside the Renku platform,
click the `Settings` tab where you will find the
git repo URLs - use `git` to clone the project on whichever machine you want.
Have you always wished Jupyter notebooks were plain text documents? Wished you could edit them in your favorite IDE? And get clear and meaningful diffs when doing version control? Then... Jupytext may well be the tool you're looking for!
### Changing interactive environment dependencies
Jupytext is a plugin for Jupyter that can save Jupyter notebooks as either
- Markdown files (or [MyST Markdown](docs/formats.md#MyST-Markdown) files, or [R Markdown](docs/formats.md#R-Markdown) or [Quarto](docs/formats.md#Quarto) text notebooks)
- Scripts in [many languages](docs/languages.md).
Initially we install a very minimal set of packages to keep the images small.
However, you can add python and conda packages in `requirements.txt` and
`environment.yml` to your heart's content. If you need more fine-grained
control over your environment, please see [the documentation](https://renku.readthedocs.io/en/latest/user/advanced_interfaces.html#dockerfile-modifications).
## Use cases
## Project configuration
Common use cases for Jupytext are:
- Doing version control on Jupyter Notebooks
- Editing, merging or refactoring notebooks in your favorite text editor
- Applying Q&A checks on notebooks.
Project options can be found in `.renku/renku.ini`. In this
project there is currently only one option, which specifies
the default type of environment to open, in this case `/lab` for
JupyterLab. You may also choose `/tree` to get to the "classic" Jupyter
interface.
## Install
## Moving forward
You can install Jupytext with
- `pip install jupytext`
- or `conda install jupytext -c conda-forge`.
Once you feel at home with your project, we recommend that you replace
this README file with your own project documentation! Happy data wrangling!
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment