secoresearch/pylode

pyLODE Docker镜像文档

镜像概述和主要用途

pyLODE是一个基于LODE（Live OWL Documentation Environment）的OWL本体文档生成工具，使用Python和rdflib库重实现LODE功能，通过Jinja2模板生成人类可读的HTML、Markdown或ADOC格式文档。该工具不仅能将OWL/RDF本体转换为易读形式，还通过要求完善的输入注释来鼓励本体注释最佳实践，适用于语义网领域的本体开发与文档化。

核心功能和特性

输入输出支持

• 输入格式：支持Turtle（.ttl）、RDF/XML（.rdf/.owl）、JSON-LD（.json）、N-Triples（.nt/.n3）等RDF格式
• 输出格式：HTML、Markdown（.md）、ASCIIDOC（.adoc）

文档配置文件

支持多种文档规范（profile）：

• ontdoc：适用于OWL本体（默认）
• vocpub：适用于SKOS词汇表或OWL本体的SKOS版本
• prof：适用于PROF（Profiles Vocabularies）配置文件

注释理解能力

• 本体元数据：支持标题（rdfs:label、skos:prefLabel等）、描述（rdfs:comment、skos:definition等）、版本（owl:versionIRI、owl:versionInfo）、命名空间（vann:preferredNamespacePrefix等）、代理（创建者、发布者等）、日期（dct:created等）、许可（dct:license）等
• 类与属性：支持类（rdfs:Class/owl:Class）和属性（owl:ObjectProperty等）的标题、描述、示例（skos:example）、层级关系（subClassOf/subPropertyOf）等
• 示例处理：支持文本、URI、图片、资源描述符（PROF ResourceDescriptor）等多种示例形式
• 代理信息：支持个人/组织代理的文本描述或对象描述（含名称、***、主页等属性）

部署方式

• 命令行工具（Python/BASH/Windows可执行文件）
• 本地HTTP服务（基于Falcon框架）
• Docker容器部署
• 在线服务（[***]

使用场景和适用范围

• 本体开发者：为OWL/SKOS本体生成结构化、易读的文档
• 语义网研究人员：展示本体设计细节，辅助协作与知识共享
• 项目集成：嵌入CI/CD流程，自动生成本体文档
• 教育与展示：以友好格式呈现本体内容，便于学习和交流

详细使用方法和配置说明

Docker安装与运行

构建镜像

bash
docker build -t pylode:latest --build-arg PYTHON_VERSION=3.8-slim .

运行容器

bash
# 基本运行（无Google Analytics）
docker run -it -d -p 8000:8000 pylode

# 启用Google Analytics（可选）
docker run -it -d -p 8000:8000 -e GTAGID=UA-XXXXXXXX-X pylode

说明：GTAGID为Google Analytics跟踪ID，非必需，格式如UA-168806395-1

访问服务

容器运行后，可通过localhost:8000访问pyLODE服务，例如：

bash
# 获取指定本体的HTML文档
curl localhost:8000/lode?url=http://sweetontology.net/sweetAll.ttl

命令行参数说明

通过Docker容器执行命令行工具时，可使用以下参数（与原生CLI一致）：

示例调用

1. 从本地文件生成HTML文档

bash
# 进入容器
docker exec -it [容器ID] /bin/bash

# 运行命令（假设本体文件为/path/to/ontology.ttl）
pylode -i /path/to/ontology.ttl -o my_ontology -f html -p ontdoc

2. 从URL生成Markdown文档

bash
docker exec -it [容器ID] pylode -u http://linked.data.gov.au/def/agrif -f md -o agrif_doc

其他运行方式

本地Falcon服务器

在容器内启动本地HTTP服务：

bash
docker exec -it [容器ID] gunicorn --chdir /app/pylode server:api

服务启动后，通过localhost:8000/pylode?url=[本体URL]访问，例如：

bash
curl localhost:8000/pylode?url=http://sweetontology.net/sweetAll.ttl

在线服务

直接使用官方在线服务：[***]

配置参数与环境变量

注意：所有命令行参数可通过docker exec在容器内直接使用，或通过挂载本地目录实现文件输入输出（如-v /local/path:/app/data）。