作为Gitlab API代理的Jupyter笔记本服务器扩展。
jupyterlab-gitlab的Python项目详细描述
Jupyterlab Gitlab
用于浏览gitlab存储库的jupyterlab扩展(只读模式)。
此扩展基于jupyterlab github。 所有的功劳都归功于jupyterlab团队,尤其是github扩展的ian rose!
同时感谢mark ghiorso,感谢jupyterlab\u gitlab 我得到一些灵感的地方。它不适合我的需要(没有服务器扩展),所以我决定根据最近的 取而代之的是jupyterlab github版本(v0.10.0)。
这个分机是什么
安装此扩展时,将添加一个附加的文件浏览器选项卡 在朱庇特实验室的左边。此文件浏览器允许您选择Gitlab 组和用户,浏览其存储库,并打开 储存库。如果这些文件是笔记本,你可以像运行它们一样 任何其他笔记本。还可以将内核附加到文本文件并运行这些文件。 基本上,您应该能够打开jupyterlab可以处理的存储库中的任何文件。
警告!当前不支持子组。这是插件在Gitlab上打开这个文件的截图:
这个分机不是什么
这不是提供完整gitlab访问权限的扩展,例如 保存文件、进行提交、分叉存储库等。
如果你想使用jupyterlab的git,你应该看看 jupyterlab git扩展。
备注
这个扩展既有一个客户端组件(也就是捆绑在一起的javascript 使用jupyterlab)和服务器端组件(即添加的python代码 到Jupyter笔记本服务器)。此扩展名将在没有服务器扩展名的情况下工作, 有一些缺点:
- 请求将未经身份验证,只允许访问公共存储库
- 未经身份验证的请求可能会根据Gitlab实例施加速率限制 (这意味着您可能需要等待才能重新获得访问权限)
- 只返回前20个结果(不遵循分页链接)
出于这些原因,您应该设置服务器扩展和实验室扩展。 此过程在安装部分中进行了说明。
先决条件
- 朱庇特实验室1.0
- 服务器扩展的gitlab帐户
安装
如上所述,此扩展既有服务器扩展,也有实验室扩展。 我们建议同时安装以允许身份验证和分页。 服务器扩展的目的是添加需要获取的gitlab凭据 从https://gitlab.com/profile/personal_access_tokens" rel="nofollow">https://gitlab.com/profile/personal_access_tokens,然后将您的请求代理到gitlab。
<H3>1。安装实验室扩展要安装实验室扩展,请在终端中输入以下内容:
jupyter labextension install jupyterlab-gitlab
只有安装了这个,扩展才能工作。
<H3>2。从Gitlab获取凭据您需要创建一个个人访问令牌以向Gitlab进行身份验证。
- 转到https://gitlab.com/profile/personal_access_tokens或从gitlab转到您的
设置
访问令牌
- 在
name
下,输入简短的说明,以确定目的 这象征的。我建议你这样做:jupyterlab gitlab
- 在scopes下,检查
api
范围。- 单击"创建个人访问令牌"。您将看到新的个人访问令牌(21个字符的字符串)。 单击"复制到剪贴板"图标并将其本地粘贴到文本文件中。 如果您有1密码这样的密码管理器,请使用它。
- 在
这是您在Gitlab中唯一看到此令牌的时间。如果你失去了它,你会 需要创建另一个。
<H3>3。安装服务器扩展使用pip安装服务器扩展,然后启用它:
pip install jupyterlab-gitlab
如果您运行的是Notebook 5.3或更高版本,这将自动启用扩展。 如果没有,请运行以下命令来启用服务器扩展:
jupyter serverextension enable --sys-prefix jupyterlab_gitlab
您可以通过运行以下命令检查服务器扩展是否已启用:
jupyter serverextension list
现在,您应该将从gitlab获得的凭据添加到笔记本配置文件中。 可以找到生成配置文件的说明 此处。 确定此文件后,请在其中添加以下行:
c.GitLabConfig.access_token="< YOUR_ACCESS_TOKEN >"
其中,<;your_access_token>;
是您在上面获得的字符串值。
定制
自定义服务器扩展
您看到了如何将访问令牌
添加到笔记本配置文件中。
除了可以使用该文件修改之外,还有其他参数。
这些是默认值:
c.GitLabConfig.allow_client_side_access_token=Falsec.GitLabConfig.url="https://gitlab.com"c.GitLabConfig.validate_cert=True
例如,如果您运行自己的gitlab实例,请更新c.gitlabconfig.url
以指向它。
自定义实验室扩展
您可以将插件设置为在启动时开始显示特定的存储库。 打开Jupyterlab设置菜单中的"高级设置"编辑器, 在gitlab设置下添加
{"baseUrl":"https://gitlab.com","defaultRepo":"owner/repository"}
其中,所有者
是gitlab用户或组,
存储库是要打开的存储库的名称。
也可以更新baseurl
以指向您自己的gitlab实例。
如果使用服务器扩展名,则此URL仅用于"在Gitlab上打开此存储库"按钮。