我们有一个合作项目，产品是Jupyter notebook，我们在过去六个月里使用了一种非常有效的方法:我们自动激活保存。py文件，并跟踪。ipynb文件和。py文件。

这样，如果有人想查看/下载最新的笔记本，他们可以通过github或nbviewer来完成，如果有人想查看笔记本代码是如何更改的，他们可以只查看.py文件的更改。

对于Jupyter笔记本服务器，可以通过添加这些行来实现

import os
from subprocess import check_call

def post_save(model, os_path, contents_manager):
    """post-save hook for converting notebooks to .py scripts"""
    if model['type'] != 'notebook':
        return # only do this for notebooks
    d, fname = os.path.split(os_path)
    check_call(['jupyter', 'nbconvert', '--to', 'script', fname], cwd=d)

c.FileContentsManager.post_save_hook = post_save

到jupyter_notebook_config.py文件并重新启动笔记本服务器。

如果你不确定在哪个目录中找到你的jupyter_notebook_config.py文件，你可以输入jupyter——config-dir，如果你没有找到这个文件，你可以输入jupyter notebook——generate-config来创建它。

对于Ipython 3笔记本服务器，可以通过添加这些行来实现

import os
from subprocess import check_call

def post_save(model, os_path, contents_manager):
    """post-save hook for converting notebooks to .py scripts"""
    if model['type'] != 'notebook':
        return # only do this for notebooks
    d, fname = os.path.split(os_path)
    check_call(['ipython', 'nbconvert', '--to', 'script', fname], cwd=d)

c.FileContentsManager.post_save_hook = post_save

到ipython_notebook_config.py文件并重新启动笔记本服务器。这些句子来自github问题的答案@minrk提供和@dror包括他们在他的SO回答以及。

对于Ipython 2笔记本服务器，可以通过使用以下命令启动服务器来完成:

ipython notebook --script

或者加上这条直线

c.FileNotebookManager.save_script = True

到ipython_notebook_config.py文件并重新启动笔记本服务器。

如果您不确定在哪个目录中找到您的ipython_notebook_config.py文件，您可以键入ipython locate profile default，如果您在那里没有找到该文件，您可以键入ipython profile create来创建它。

这是我们在github上使用这种方法的项目:这是一个github上探索笔记本电脑最近变化的例子。

我们对此非常满意。

更新:现在你可以编辑Jupyter笔记本 文件直接在Visual Studio Code。您可以选择编辑 笔记本或转换后的python文件。

我终于找到了一个高效而简单的方法，可以让Jupyter和Git很好地一起工作。我还在第一步，但我已经认为它比所有其他复杂的解决方案要好得多。

Visual Studio Code是微软的一个很酷的开源代码编辑器。它有一个优秀的Python扩展，现在允许你导入一个Jupyter笔记本作为Python代码。现在你也可以直接编辑Jupyter笔记本。

将笔记本导入python文件后，所有代码和标记都将放在一个普通的python文件中，注释中有特殊标记。如下图所示:

你的python文件只有笔记本输入单元格的内容。输出将在拆分窗口中生成。你的笔记本里有纯代码，你只是执行它，它不会改变。没有混合输出与您的代码。没有奇怪的JSON难以理解的格式来分析你的差异。

只是纯粹的python代码，你可以很容易地识别每一个差异。

我甚至不再需要为我的.ipynb文件设置版本了。我可以写上*。Ipynb线在。gitignore。

需要生成一个笔记本来发布或与他人共享?没问题，只需在交互式python窗口中单击导出按钮

如果你直接编辑笔记本，现在有一个图标Convert and save to a python script。

这是Visual Studio Code中一个笔记本的截图:

我只使用了一天，但我终于可以愉快地使用Jupyter和Git了。

注:VSCode的代码完成比Jupyter好得多。

这是我的解决方案与git。它允许你像往常一样添加和提交(和diff):这些操作不会改变你的工作树，同时(重新)运行一个笔记本不会改变你的git历史。

虽然这可能适用于其他VSC，但我知道它不能满足您的要求(至少VSC不可知)。不过，它对我来说是完美的，尽管它没有什么特别出色的地方，而且很多人可能已经在使用它了，但我没有通过谷歌找到关于如何实现它的明确说明。所以它可能对其他人有用。

将包含此内容的文件保存在某个位置(对于下面的内容，让我们假设~/bin/ipynb_output_filter.py) (chmod +x ~/bin/ipynb_output_filter.py) 创建文件~/。Gitattributes，包含以下内容 *。ipynb过滤器= dropoutput_ipynb 执行如下命令: Git配置——全局核心。attributesfile ~ / .gitattributes Git配置——global filter.dropoutput_ipynb。干净的~ / bin / ipynb_output_filter.py Git配置——global filter.dropoutput_ipynb。涂抹的猫

完成了!

限制:

it works only with git in git, if you are in branch somebranch and you do git checkout otherbranch; git checkout somebranch, you usually expect the working tree to be unchanged. Here instead you will have lost the output and cells numbering of notebooks whose source differs between the two branches. more in general, the output is not versioned at all, as with Gregory's solution. In order to not just throw it away every time you do anything involving a checkout, the approach could be changed by storing it in separate files (but notice that at the time the above code is run, the commit id is not known!), and possibly versioning them (but notice this would require something more than a git commit notebook_file.ipynb, although it would at least keep git diff notebook_file.ipynb free from base64 garbage). that said, incidentally if you do pull code (i.e. committed by someone else not using this approach) which contains some output, the output is checked out normally. Only the locally produced output is lost.

我的解决方案反映了这样一个事实:我个人不喜欢对生成的东西进行版本控制——注意，涉及输出的合并几乎肯定会使输出或您的生产力无效，或者两者都无效。

编辑:

如果你确实采用了我建议的解决方案——也就是全局的解决方案——你会遇到一些麻烦，比如你想要版本输出的git repo。因此，如果你想禁用特定git存储库的输出过滤，只需在其中创建一个文件.git/info/attributes，使用 **ipynb过滤器=

作为内容。显然，以同样的方式也可以做相反的事情:仅为特定的存储库启用筛选。

代码现在在它自己的git repo中维护 如果上面的指令导致ImportErrors，尝试在脚本路径之前添加"ipython": Git配置——global filter.dropoutput_ipynb。清除ipython ~/bin/ipynb_output_filter.py

编辑:2016年5月(更新于2017年2月):我的脚本有几个替代方案-为了完整性，这里是我知道的列表:nbstripout(其他变体)，nbstrip, jq。

好吧，所以看起来目前最好的解决方案，根据这里的讨论，是使一个git过滤器自动剥离ipynb文件提交的输出。

以下是我让它工作的方法(摘自讨论):

我稍微修改了cfriedline的nbstripout文件，当你不能导入最新的IPython时，会给出一个提示性错误: https://github.com/petered/plato/blob/fb2f4e252f50c79768920d0e47b870a8d799e92b/notebooks/config/strip_notebook_output 并将它添加到我的repo中，比如在。/relative/path/to/strip_notebook_output中

还添加了文件.gitattributes文件到repo的根目录，包含:

*.ipynb filter=stripoutput

并创建了setup_git_filters.sh，其中包含

git config filter.stripoutput.clean "$(git rev-parse --show-toplevel)/relative/path/to/strip_notebook_output" 
git config filter.stripoutput.smudge cat
git config filter.stripoutput.required true

并运行source setup_git_filters.sh。花哨的$(git rev-parse…)事情是找到你的回购在任何(Unix)机器上的本地路径。

不幸的是，我对Mercurial了解不多，但我可以为您提供一个与Git一起工作的可能解决方案，希望您能够将我的Git命令转换为对应的Mercurial命令。

对于后台，在Git中，add命令将对文件所做的更改存储到暂存区域。完成此操作后，Git将忽略对文件的任何后续更改，除非您告诉它也执行这些更改。因此，下面的脚本，对于每个给定的文件，剥离所有的输出和prompt_number部分，运行剥离的文件，然后恢复原始文件:

注意:如果运行此命令会得到类似ImportError的错误消息:没有名为IPython的模块。Nbformat，然后使用ipython而不是python来运行脚本。

from IPython.nbformat import current
import io
from os import remove, rename
from shutil import copyfile
from subprocess import Popen
from sys import argv

for filename in argv[1:]:
    # Backup the current file
    backup_filename = filename + ".backup"
    copyfile(filename,backup_filename)

    try:
        # Read in the notebook
        with io.open(filename,'r',encoding='utf-8') as f:
            notebook = current.reads(f.read(),format="ipynb")

        # Strip out all of the output and prompt_number sections
        for worksheet in notebook["worksheets"]:
            for cell in worksheet["cells"]:
               cell.outputs = []
               if "prompt_number" in cell:
                    del cell["prompt_number"]

        # Write the stripped file
        with io.open(filename, 'w', encoding='utf-8') as f:
            current.write(notebook,f,format='ipynb')

        # Run git add to stage the non-output changes
        print("git add",filename)
        Popen(["git","add",filename]).wait()

    finally:
        # Restore the original file;  remove is needed in case
        # we are running in windows.
        remove(filename)
        rename(backup_filename,filename)

一旦脚本在您想要提交的文件上运行，只需运行git commit。

在删除笔记本的输出数年之后，我试图提出一个更好的解决方案。我现在使用Jupytext，这是我设计的Jupyter Notebook和Jupyter Lab的扩展。

Jupytext可以转换Jupyter笔记本到各种文本格式(脚本，Markdown和R Markdown)。反之。它还提供了将笔记本与这些格式之一配对的选项，并自动同步笔记本的两种表示形式(.ipynb和.md/.py/)。R文件)。

让我来解释一下Jupytext是如何回答上述问题的:

允许我在包含或不包含输出之间进行选择，

。海事/ . py。R文件只包含输入单元格。您应该始终跟踪该文件。只有在希望跟踪输出时，才对.ipynb文件进行版本控制。

防止我不小心提交输出，如果我不想要它，

将 *.ipynb 添加到 .gitignore

允许我保持本地版本的输出，

输出保存在(local) .ipynb文件中

允许我看到当我使用我的版本控制系统在输入中有变化时(即，如果我只控制输入，但我的本地文件有输出，那么我希望能够看到输入是否发生了变化(需要提交)。使用版本控制状态命令将总是注册一个差异，因为本地文件有输出。)

.py/。R或。md文件是你要找的

允许我从更新的干净笔记本更新我的工作笔记本(其中包含输出)。(更新)

获取.py/. xml文件的最新修订版本。R或。md文件，并刷新你的笔记本在Jupyter (Ctrl+R)。您将从文本文件中获得最新的输入单元格，并从.ipynb文件中获得匹配的输出。内核不受影响，这意味着您的局部变量被保留-您可以继续在离开它的地方工作。

我喜欢Jupytext的地方是它的笔记本(以.py/。R或.md文件)可以在您喜欢的IDE中编辑。使用这种方法，重构笔记本变得很容易。一旦你完成了，你只需要在Jupyter刷新笔记本。

如果你想尝试一下:安装Jupytext与pip安装Jupytext并重新启动你的Jupyter笔记本或实验室编辑器。打开要进行版本控制的笔记本，并使用Jupyter notebook中的Jupytext菜单(或Jupyter Lab中的Jupytext命令)将其配对到Markdown文件(或脚本)。保存您的笔记本，您将得到两个文件:原始的.ipynb，加上承诺的笔记本文本表示，这非常适合版本控制!

对于那些可能感兴趣的人:在命令行上也可以使用Jupytext。