开源项目教程：tuitorial

开源项目教程：tuitorial

tuitorial Create beautiful terminal-based code tutorials with syntax highlighting and interactive navigation. 项目地址: https://gitcode.com/gh_mirrors/tu/tuitorial

1. 项目目录结构及介绍

tuitorial 项目是一个用于创建美丽终端代码教程的工具，其目录结构如下：

• docs/：存放项目文档。
• examples/：包含示例教程文件。
• tests/：包含单元测试代码。
• tuitorial/：主程序代码目录。
• .gitattributes：Git 属性配置文件。
• .gitignore：Git 忽略文件列表。
• Dockerfile：用于构建 Docker 容器的文件。
• LICENSE：项目许可证文件。
• MANIFEST.in：打包时包含的文件列表。
• README.md：项目自述文件。
• pyproject.toml：Python 项目配置文件。

2. 项目的启动文件介绍

项目的启动主要通过以下文件进行：

• tuitorial.py：这是项目的主入口文件，其中定义了 TuitorialApp 类，用于运行教程。
• run_yaml.py：用于从 YAML 文件启动教程的脚本。

启动项目的基本命令如下：

pip install tuitorial
uvx tuitorial https://raw.githubusercontent.com/basnijholt/tuitorial/refs/heads/main/examples/pipefunc.yaml

或者使用 Python 直接运行：

from tuitorial import Chapter, Step, TuitorialApp, Focus
# ... 其他相关代码 ...
app = TuitorialApp([chapter1, chapter2])
app.run()

3. 项目的配置文件介绍

项目的主要配置文件是 pyproject.toml，该文件用于定义项目的元数据和依赖项。以下是一个示例：

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
packages = ["tuitorial"]
python-requires = ">=3.7"
install-requires = [
    "rich",
    # ... 其他依赖 ...
]

[project]
name = "tuitorial"
version = "0.1.0"
description = "Create beautiful terminal-based code tutorials with syntax highlighting and interactive navigation."
authors = ["Bas van Slooten <bas@basnijholt.com>"]
license = { file = "LICENSE" }
readme = "README.md"
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: MIT License",
    # ... 其他分类 ...
]

这个文件定义了项目的名称、版本、描述、作者、许可证和依赖项等信息。此外，项目还可能使用其他配置文件，如 .pre-commit-config.yaml，用于配置代码风格检查和自动格式化。

tuitorial Create beautiful terminal-based code tutorials with syntax highlighting and interactive navigation. 项目地址: https://gitcode.com/gh_mirrors/tu/tuitorial