pyobsplot 项目教程

pyobsplot 项目教程

pyobsplot Observable Plot in Jupyter notebooks and Quarto documents 项目地址: https://gitcode.com/gh_mirrors/py/pyobsplot

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

pyobsplot 项目的目录结构如下：

pyobsplot/
├── doc/
│   └── data/
├── examples/
├── packages/
│   └── pyobsplot-js/
├── src/
├── tests/
├── utils/
├── .gitignore
├── .python-version
├── LICENSE
├── NEWS.md
├── README.md
├── package-lock.json
├── package.json
├── pyproject.toml
└── uv.lock

目录结构介绍

• doc/: 包含项目的文档和示例数据。
• examples/: 包含项目的示例代码。
• packages/pyobsplot-js/: 包含与 JavaScript 相关的代码和包。
• src/: 包含项目的主要源代码。
• tests/: 包含项目的测试代码。
• utils/: 包含项目的实用工具代码。
• .gitignore: Git 忽略文件配置。
• .python-version: Python 版本配置文件。
• LICENSE: 项目许可证文件。
• NEWS.md: 项目更新日志。
• README.md: 项目介绍和使用说明。
• package-lock.json: npm 包锁定文件。
• package.json: npm 包配置文件。
• pyproject.toml: Python 项目配置文件。
• uv.lock: 项目依赖锁定文件。

2. 项目的启动文件介绍

pyobsplot 项目的启动文件是 src/pyobsplot/__init__.py。这个文件是项目的入口文件，负责初始化和配置 pyobsplot 库。

启动文件介绍

• __init__.py: 这个文件是 Python 包的初始化文件，通常包含包的初始化代码和导出的模块。

3. 项目的配置文件介绍

pyobsplot 项目的主要配置文件是 pyproject.toml 和 package.json。

配置文件介绍

• pyproject.toml: 这个文件是 Python 项目的配置文件，包含了项目的依赖、构建工具和其他配置信息。
• package.json: 这个文件是 npm 包的配置文件，包含了 JavaScript 部分的依赖、脚本和其他配置信息。

配置文件示例

pyproject.toml

[tool.poetry]
name = "pyobsplot"
version = "0.1.2"
description = "Observable Plot in Jupyter notebooks"
authors = ["Julien Barnier <julien.barnier@cnrs.fr>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.10"

[tool.poetry.dev-dependencies]
pytest = "^6.2.5"

package.json

{
  "name": "pyobsplot",
  "version": "0.1.2",
  "description": "Observable Plot in Jupyter notebooks",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Julien Barnier",
  "license": "MIT",
  "dependencies": {
    "observable-plot": "^0.1.2"
  }
}

通过以上配置文件，可以管理和配置 pyobsplot 项目的依赖和构建工具。

pyobsplot Observable Plot in Jupyter notebooks and Quarto documents 项目地址: https://gitcode.com/gh_mirrors/py/pyobsplot