gitautopush

监视本地git仓库的任何更改，并自动将其推送到GitHub。

作为教学实时同步工具很有用。比如说，您有一个Jupyter笔记本（或Markdown文件），您在授课过程中添加代码。当您向文件添加内容时，您希望学生在任何时候都能访问“最新”版本。

gitautopush可以让您自动跟踪git仓库的最新更改，并将其自动推送到GitHub。然后您可以要求学生访问GitHub或nbviewer链接，他们就能看到您所做的任何更改。

请参阅下面的GIF示例。

安装

您可以使用pip进行安装

pip安装gitautopush

用法

首先，请确保您已将GitHub仓库克隆到本地文件夹。

然后，运行gitautopush并将其指向该文件夹

gitautopush /path/to/my/repo/folder

gitautopush将开始监视此文件夹的任何更改。当它找到更改时，它将提交更改并将文件夹内容推送到GitHub。它还会显示一些您可以与学生分享的链接，以帮助他们跟进。

参数

以下是可以用于自定义Gitautopush行为的参数。

• --sleep <INT> - 在尝试同步之间的等待时间（以秒为单位）。
• --path <STRING> - 要监视和同步的文件夹的路径。

通过示例用例进行教程

以下是gitautopush的一个常见用例

您正在教授软件工艺坊，并希望在使用Jupyter笔记本进行工作。您有一个“主副本”作为工作基础，但您不想在开始之前把整个内容都给学生。您的计划是在学生观看的同时在空笔记本中工作，并希望学生在任何时候都能访问笔记本的最新版本。

首先，您 创建一个空GitHub仓库，我们将其称为gitautopush-demo。接下来，我们将创建一个文件夹，我们将在此处进行工作

接下来，您 将此空仓库克隆到您的计算机

git clone https://github.com/choldgraf/gitautopush-demo

现在，运行gitautopush并指向新文件夹。我们将告诉它在每次检查后睡眠10秒。

gitautopush --path ./gitautopush-demo --sleep 10

gitautopush将打印一些有用的链接，并开始检查文件夹中的任何更改。当它找到一个更改时，它将提交更改到仓库并推送结果。它还会为任何更改的Jupyter笔记本打印一个nbviewer链接。您可以与您的学生分享这些链接。

最后，打开一个新的终端窗口，并使用它来启动应用程序（例如Jupyter Lab、Jupyter Notebook或您自己的文本编辑器）来编辑内容。

在做出更改时，注意提供的链接并与您的学生分享。

致谢

这个工具最初由John Lee想出，然后由Chris Holdgraf将其改编为Python模块。