JupyterLab GitHub

一个用于访问GitHub仓库的JupyterLab扩展。

此扩展是什么

当您安装此扩展时，JupyterLab左侧区域将添加一个额外的文件浏览器标签。此文件浏览器允许您选择GitHub组织和用户，浏览他们的仓库，并打开这些仓库中的文件。如果这些文件是笔记本，您可以像其他任何笔记本一样运行它们。您还可以将内核附加到文本文件并运行它们。基本上，您应该能够打开JupyterLab可以处理的任何仓库中的文件。

以下是此插件在GitHub上打开此文件的截图：

此扩展不是什么

这不是一个提供完整GitHub访问的扩展，例如保存文件、创建提交、分支仓库等。为了做到这一点，它几乎需要重新发明GitHub网站，这将大大增加扩展的复杂性。

关于速率限制的说明

此扩展包含客户端组件（即与JupyterLab捆绑的JavaScript）和服务器端组件（即添加到Jupyter服务器的Python代码）。此扩展将在没有服务器扩展的情况下工作，但有一个重大前提：当我们必须向GitHub发起未经身份验证的请求以获取存储库数据时，GitHub对我们可以发起多少请求施加了相当严格的速率限制。因此，您可能会在几分钟内达到此限制。然后您可能需要等待长达一小时才能重新获得访问权限。

因此，我们建议您花费时间和精力设置服务器扩展以及实验室扩展，这将允许您访问更高的速率限制。此过程在安装部分有所描述。

先决条件

• JupyterLab > 3.0
• 用于服务器扩展的GitHub账户

安装

如上所述，此扩展既有服务器扩展也有实验室扩展。在从PyPI安装时，这两个扩展都将默认安装，但如果您在JupyterLab中使用扩展管理器，可能只安装了实验室扩展。

我们建议您完成以下步骤，以避免速率限制。服务器扩展的目的是添加您需要从https://github.com/settings/developers获取的GitHub凭据，然后代理您的GitHub请求。

对于版本低于3的JupyterLab，请参阅2.x分支上的说明。

1. 安装服务器和预构建实验室扩展

JupyterLab 4.x

要安装服务器扩展和（预构建）实验室扩展，请在终端中输入以下内容

pip install jupyterlab-github

JupyterLab 3.x

我们需要将扩展版本锁定为3.0.1，以便使其在JupyterLab 3.x上工作。

pip install 'jupyterlab-github==3.0.1'

重新启动JupyterLab后，扩展应该可以正常工作，您将亲自体验速率限制的乐趣！

2. 从GitHub获取您的凭据

从GitHub获取凭据有两种方法：（1）您可以获取访问令牌，（2）您可以注册OAuth应用程序。第二种方法不建议使用，并将在未来的版本中删除。

获取访问令牌（推荐）

您可以通过以下步骤获取访问令牌

1. 验证您的GitHub电子邮件地址。
2. 转到GitHub上的账户设置，并在左侧面板中选择“开发者设置”。
3. 在左侧，选择“个人访问令牌”
4. 单击“生成新令牌”按钮，并输入您的密码。
5. 为令牌提供一个描述，并勾选“repo”作用域框。
6. 单击“生成令牌”
7. 您将获得一个字符串，这就是您的访问令牌。

请记住，此令牌实际上是您GitHub账户的密码。请不要将其在线分享或将令牌存入版本控制，因为人们可以使用它来访问GitHub上您所有的数据。

设置OAuth应用程序（已弃用）

此方法用于与GitHub进行身份验证已弃用，并将被删除。新用户应使用访问令牌方法。您可以通过以下步骤在GitHub上注册OAuth应用程序

1. 登录您的GitHub账户。
2. 转到https://github.com/settings/developers，并在左侧选择“OAuth应用程序”标签页。
3. 单击“新OAuth应用程序”按钮。
4. 在表单中填写名称、主页URL、描述和回调URL。此扩展实际上没有使用OAuth，因此这些值实际上并不重要，您只需要填写它们以注册应用程序。
5. 单击“注册应用程序”按钮。
6. 您应该被带到一个新的页面，其中包含新的应用程序信息。如果您看到显示“客户端ID”和“客户端密钥”的字段，恭喜您！这些是我们需要的字符串，您已经成功设置了应用程序。

需要注意的是，“客户端密钥”字符串正如其名，是保密的。不要 在网上共享此值，因为人们可能能够用它来在GitHub上冒充您。

3. 启用和配置服务器扩展

如果您使用pip安装了它，新JupyterLab安装将默认启用服务器扩展。如果您在JupyterLab中使用了扩展管理器，请按照步骤（1）中的说明卸载扩展并重新安装。

使用以下方法确认服务器扩展已安装和启用：

jupyter server extension list

您应该看到以下内容

- Validating jupyterlab_github...
     jupyterlab_github 4.0.0 OK

在某些较旧的安装（例如旧的JupyterHub版本）中，这些安装使用jupyter notebook服务器而不是新的jupyter-server，则扩展需要显示在传统的serverextensions列表中（注意：在server和extension之间没有空格）

jupyter serverextension list

如果扩展没有启用，请运行

jupyter server extension enable jupyterlab_github

或者如果您使用的是传统的notebook服务器

jupyter serverextension enable jupyterlab_github

现在您需要将您从GitHub获得的凭据添加到您的服务器配置文件中。有关生成配置文件的说明，请参阅此处。一旦您找到了该文件，请向其中添加以下行

c.GitHubConfig.access_token = '< YOUR_ACCESS_TOKEN >'

其中 "< YOUR_ACCESS_TOKEN >" 是您上面获得的字符串值。如果您生成了一个OAuth应用，则输入以下内容

c.GitHubConfig.client_id = '< YOUR_CLIENT_ID >'
c.GitHubConfig.client_secret = '< YOUR_CLIENT_SECRET >'

其中 "< YOUR_CLIENT_ID >" 和 "< YOUR_CLIENT_SECRET >" 是您上面获得的app值。

有了这些，您应该完成了！启动JupyterLab，并在左侧寻找GitHub标签页！

自定义

您可以将插件设置为在启动时显示特定的存储库。在设置菜单中打开“高级设置”编辑器，在GitHub设置下添加

{
  "defaultRepo": "owner/repository"
}

其中 owner 是GitHub用户/org，repository 是您想要打开的存储库名。