Skip to main content

Jupyter Notebook 中用户友好的小部件和工具的框架。

项目描述

[粘合剂

工具

nbtools是一个用于创建用户友好的 Jupyter 笔记本的软件包,编程和非编程用户都可以访问。该软件包提供:

  • 一个可以将任何 Python 函数转换为交互式用户界面的装饰器。
  • 用于封装新计算步骤并将其添加到笔记本的工具箱界面。
  • 灵活的主题和 API 来扩展 nbtools 功能。
  • Markdown 单元的 WYSIWYG 编辑器(作为随附juptyter-wyswyg软件包的一部分提供)。

nbtools是作为GenePattern Notebook环境的一部分开发的。该环境还可以作为 nbtools 如何扩展并应用于特定领域的示例:在它的例子中是生物信息学。

寻找 JupyterLab 支持?

JupyterLab 支持目前处于测试阶段。你可以在它自己的分支中找到它。只需点击这里!

安装

nbtools可通过PIPconda获得。只需运行以下命令之一。

点安装 nbtools

或者

conda install -c 基因模式 nbtools

如果使用 Jupyter Notebook 版本 <= 5.2,则需要执行其他命令来安装和启用 nbextension。在 Jupyter 5.3+ 中这不是必需的。

jupyter nbextension 安装 --py nbtools

jupyter nbextension 启用 --py nbtools

入门

让我们首先编写一个简单的 Hello World 函数并将其转换为交互式小部件。继续安装 nbtools,启动 Jupyter 并打开一个新的空白笔记本。

完成后,让我们编写一个基本函数。下面的函数接受一个字符串并打印一条简短的消息。默认情况下,消息面向全世界。为了更好地衡量,我们还将添加一个文档字符串来记录该函数。

def say_hello(to_whom='World'):
    """Say hello to the world or whomever."""
    print('Hello ' + to_whom)

这是非常基本的 Python,希望到目前为止一切都很熟悉。接下来,我们将把这个函数变成一个交互式小部件,只需要一个导入语句和一行代码。将您的代码更新为如下所示并执行该单元格。

导入 nbtools

@nbtools build_ui 
def say_hello(to_whom='World'):
    """Say hello to the world or whomever."""
    print('Hello ' + to_whom)

您现在应该会看到一个包含 Web 表单的小部件。此表单将提示输入to_whom参数的值。文档字符串也将显示为小部件顶部附近的描述。继续并更改to_whom值,然后单击“运行”按钮。这将执行函数并打印下面的结果。同时,表单也会折叠,在屏幕上腾出更多空间。

只需按一下按钮,您就可以运行该say_hello功能!

这很令人兴奋,但它远非 nbtools 包的唯一功能。您可以使用 WYSIWYG 编辑器编辑 markdown 单元格,自定义函数的显示方式,将多个相关函数链接在一起,从现有的第三方方法制作小部件,创建交互式工具库(只需单击工具栏上的工具按钮,您将看到say_hello已经添加了自己)等等!只需查看下面的文档链接。

特征

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

nbtools-21.12.tar.gz (5.1 MB 查看哈希

已上传 source

内置分布

nbtools-21.12-py3-none-any.whl (2.7 MB 查看哈希

已上传 py3