Euporie 项目教程

Euporie 项目教程

euporieJupyter notebooks in the terminal项目地址:https://gitcode.com/gh_mirrors/eu/euporie

1. 项目的目录结构及介绍

Euporie 项目的目录结构如下：

euporie/
├── euporie/
│   ├── __init__.py
│   ├── console.py
│   ├── notebook.py
│   ├── preview.py
│   ├── hub.py
│   ├── config/
│   │   ├── __init__.py
│   │   ├── settings.py
│   ├── utils/
│   │   ├── __init__.py
│   │   ├── helpers.py
├── tests/
│   ├── __init__.py
│   ├── test_console.py
│   ├── test_notebook.py
│   ├── test_preview.py
│   ├── test_hub.py
├── docs/
│   ├── index.rst
│   ├── conf.py
│   ├── installation.rst
│   ├── usage.rst
├── README.md
├── setup.py
├── requirements.txt
├── LICENSE

目录结构介绍

• euporie/: 项目的主目录，包含了所有核心代码。
  • __init__.py: 初始化文件，用于将目录标记为 Python 包。
  • console.py: 控制台应用的入口文件。
  • notebook.py: 笔记本应用的入口文件。
  • preview.py: 笔记本预览应用的入口文件。
  • hub.py: 多用户 SSH 服务器的入口文件。
  • config/: 配置文件目录。
    • settings.py: 配置文件，包含项目的各种设置。
  • utils/: 工具函数目录。
    • helpers.py: 包含一些辅助函数。
• tests/: 测试代码目录。
  • test_console.py: 控制台应用的测试文件。
  • test_notebook.py: 笔记本应用的测试文件。
  • test_preview.py: 预览应用的测试文件。
  • test_hub.py: 多用户 SSH 服务器的测试文件。
• docs/: 文档目录。
  • index.rst: 文档主页。
  • conf.py: Sphinx 文档配置文件。
  • installation.rst: 安装指南。
  • usage.rst: 使用指南。
• README.md: 项目介绍文件。
• setup.py: 安装脚本。
• requirements.txt: 依赖包列表。
• LICENSE: 项目许可证。

2. 项目的启动文件介绍

console.py

console.py 是 Euporie 控制台应用的启动文件。它允许用户在终端中与 Jupyter 内核交互，运行代码。

notebook.py

notebook.py 是 Euporie 笔记本应用的启动文件。它允许用户在终端中编辑和运行 Jupyter 笔记本。

preview.py

preview.py 是 Euporie 笔记本预览应用的启动文件。它允许用户在终端中预览 Jupyter 笔记本。

hub.py

hub.py 是 Euporie 多用户 SSH 服务器的启动文件。它允许用户通过 SSH 连接到 Euporie 应用。

3. 项目的配置文件介绍

config/settings.py

settings.py 是 Euporie 项目的配置文件。它包含了项目的各种设置，如内核配置、终端图形设置、键绑定配置等。

配置示例

# 内核配置
KERNEL_CONFIG = {
    'default': 'python3',
    'kernels': {
        'python3': {
            'path': '/usr/local/bin/python3',
            'args': ['-m', 'ipykernel']
        }
    }
}

# 终端图形设置
TERMINAL_GRAPHICS = {
    'sixel': True,
    'iterm': True,
    'kitty': True
}

# 键绑定配置
KEY_BINDINGS = {
    'console': {
        'quit': 'Ctrl+Q',
        'run': 'Ctrl+R'
    },
    'notebook': {
        'save': 'Ctrl+S',
        'run': 'Ctrl+R'
    }
}

通过修改 settings.py 文件，用户可以自定义 Euporie 的行为和外观。

euporieJupyter notebooks in the terminal项目地址:https://gitcode.com/gh_mirrors/eu/euporie