civis-jupyter-notebook 1.0.0

用法

在Dockerfile中，将以下代码放在末尾：

RUN pip install civis-jupyter-notebook && \
    civis-jupyter-notebooks-install

# Add Tini
ENV TINI_VERSION v0.16.1
ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini /tini
RUN chmod +x /tini

ENV DEFAULT_KERNEL <your kernel>  # set to one of python3, python2 or ir
EXPOSE 8888
WORKDIR /root/work
ENTRYPOINT ["/tini", "--"]
CMD ["civis-jupyter-notebooks-start"]

这里需要用内核的名称替换<your kernel>（例如， 其中一个是python2、python3或ir）。注意，Dockerfile必须使用 root作为默认用户。

有关详细信息，请参见exampledocker图像。

集成测试Docker图像与CIVIS平台

如果要在本地测试图像与civis平台的集成，请执行以下步骤：

1. 在civis平台帐户中创建一个笔记本并获取笔记本的id。这个ID是号码 出现在笔记本的url结尾，https://platform.civisanalytics.com/#/notebooks/<NOTEBOOK ID>。

2. 创建名为my.env的环境文件，并向其中添加以下内容：

   PLATFORM_OBJECT_ID=<NOTEBOOK ID>
   CIVIS_API_KEY=<YOUR CIVIS API KEY>
   

3. 在本地生成图像：docker build -t test .。

4. 运行容器：docker run --rm-p 8888:8888 --env-file my.env test。

5. 使用端口8888（例如http://localhost:8888/notebooks/notebook.ipynb）访问Docker主机IP上的笔记本电脑。

使用civis平台更改集成测试代码

脚本tests/build_dev_image.sh和tests/run_dev_image.sh可用于测试 coee变更与civis平台的集成。

从repo的顶部目录中键入：

$ ./test/build_dev_image.sh
$ ./test/run_dev_image.sh <NOTEBOOK ID>

其中<NOTEBOOK ID>是civis平台笔记本的id。如果没有，请参见上面的步骤1 有笔记本ID。然后您可以从本地浏览器连接到笔记本并检查 以确保它正常工作。

贡献

请参阅CONTIBUTING.md以获取有关对此项目作出贡献的信息。

许可证

BSD-3

有关详细信息，请参见LICENSE.md。