From 4eba251bbcd7aff6ef34790bb7f0e0f144e5b697 Mon Sep 17 00:00:00 2001 From: releng bot Date: Wed, 15 May 2024 21:49:09 +0000 Subject: [PATCH] Added the README --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..10c693f --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# python-jupytext + +Have you always wished [Jupyter](https://jupyter.org/) 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](https://jupytext.readthedocs.io/) may well be the tool +you're looking for! + +[Jupytext](https://jupytext.readthedocs.io/) is a plugin for Jupyter that can +save Jupyter notebooks as +- Markdown files (or MyST Markdown files, or R Markdown or Quarto text + notebooks) +- Scripts in many languages. + +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. \ No newline at end of file