pylode 3.2.0

内容

1. 快速入门

2. 使用

3. pyLODE理解的内容

4. 示例

5. 安装

6. 测试

7. 与LODE的区别

8. 发布

9. 许可

10. 引用

11. 合作

12. 联系方式

快速入门

实时OWL文档环境工具（LODE）是一个知名的（在语义网领域）基于Java和XSLT的工具，用于生成人类可读的HTML文档，用于OWL和RDF本体。该工具现在已经有些过时（老式HTML，使用像XSLT这样的旧技术）并且其（《在线版本》）并不总是在线的。

此工具是LODE功能的完整重新实现，使用Python和Python的RDF操作模块rdflib。要文档化的本体使用rdflib进行解析和检查，并直接使用Python的dominate包生成HTML。

使用

该工具可以用多种方式使用

• BASH命令行脚本

  • bin/中的pyLODE.sh

• Windows EXE

  • bin/中的pyLODE.exe

• Mac可执行文件

  • bin/中的pyLODE

• Python脚本

  • cli.py或模块

• 本地作为服务

  • 通过流行的Falcon框架。

  • 请参阅主文件夹中的server.py

• 在线作为服务

  • 托管在https://pylode.surroundaustralia.com

usage: cli.py [-h] [-v] [-o OUTPUTFILE] [-c {true,false}] input

positional arguments:
    input                 Input file location or URL

optional arguments:
    -h, --help          show this help message and exit
    -v, --version       show program's version number and exit
    -o OUTPUTFILE,
    --outputfile OUTPUTFILE
                        A name you wish to assign to the output file. Will be
                        postfixed with .html if not already added. If no
                        output file is given, output will be printed to screen
    -c {true,false},
    --css {true,false}
                        Whether (true) or not (false) to include CSS within an
                        output HTML file.

python pylode examples/ontpub/minimal.ttl -o minimal.html

docker build -t pylode:latest .

docker  run  --mount 'type=bind,src=<ttl_directory>,target=/app/pylode/data' pylode:latest  python3.10 pylode/cli.py data/<ttl_file> -o data/<html_file>

from pylode.profiles.ontpub import OntPub

# initialise
od = OntPub(ontology="some-ontology-file.ttl")

# produce HTML
html = od.make_html()

# or save HTML to a file
od.make_html(destination="some-resulting-html-file.html")

from pylode.profiles.vocpub import VocPub

# initialise
od = VocPub(ontology="some-ontology-file.ttl")

# produce HTML
html = od.make_html()

# or save HTML to a file
od.make_html(destination="some-resulting-html-file.html")

示例

examples/目录包含多个由pyLODE此版本生成的RDF和HTML文件的配对。

您还可以在网上查看这些示例文件的渲染版本

• minimal.html

• agift.html

• alternates.html

• asgs.html

pyLODE理解的内容

pyLODE了解定义本体（owl:Ontology）以及通常在其中找到的主要元素，例如类（owl:Class或rdf:Class）和属性（rdf:Property和owl:ObjectProperty等）。

要查看pyLODE当前支持的本体、类和RDF属性文档的属性，只需查看rdf_elements.py文件。所有支持的元素属性都列在那里。

pyLODE不会将您可以在RDF中描述的所有内容都翻译成HTML！这是一个有意识的设计选择，以确保生成某种传统的文档本体风格。然而，可以通过创建此项目的Issue tracker上的问题来支持新的属性和本体模式。

虽然它确实了解实例数据，例如命名个体，但它并不是为了文档化包含类实例的大型本体而设计的。

<ontology_x>
    dct:creator [
        sdo:name "Nicholas J. Car" ;
        sdo:identifier <http://orcid.org/0000-0002-8742-7730> ;
        sdo:affiliation [
            sdo:name "SURROUND Australia Pty Ldt." ;
            sdo:url "https://surroundaustralia.com"^^xsd:anyURI ;
        ] ;
    ] ;
.

安装

pyLODE 已在 PyPI 上发布，因此您可以使用 pip 正常安装

pip install pylode

测试

最好禁用警告以隐藏 RDFLib 库中无意义的警告。

python -m pytest tests --disable-warnings

与LODE的区别

• 命令行访问

  • 您可以在自己的桌面上使用它，因此不需要我为使用维护实时服务

• 使用现代简单的 HTML

  • 无 JavaScript：pyLODE 生成静态 HTML 页面

• 适用于更广泛的本体选项，例如

  • schema.org 的 domainIncludes & rangeIncludes 属性

• 更好的代理表示

  • 请参阅上方的 代理说明 部分

• 更智能的 CURIES

  • pyLODE 缓存并查找知名前缀以创建更多/更好的 CURIES

  • 它通过 CURIE 化所有找到的 URI 而不是直接打印它们来尝试智能地呈现 CURIE

• 参考本体属性标签

  • pyLODE 缓存约 10 个知名本体（RDFS、SKOS 等），这些本体属性常用于本体文档。在这些属性中使用时，将使用背景本体的标签

• 积极开发

  • pyLODE 自 2019 年中以来一直在积极开发，并且仍然在积极开发 - 它不是停滞不前

  • 它将在可预见的未来得到改进，以适应更多事物

  • 如果需要，将处理最近的本体文档计划，如 MOD Ontology

发布

pyLODE 在持续和不断地开发中。当前的开发者已经制定了增强功能的路线图，这里给出，但是，由于这是一个开源项目，新开发者可能加入 pyLODE 开发社区，并改变/添加开发优先级。

许可

本代码使用BSD 3-Clause许可证授权。有关许可证详情，请参阅许可证文件。注意以下引用，以示归属。

引用

如果您使用pyLODE，请在发布的HTML页面顶部左侧保留pyLODE标志并带有指向此页面的超链接。

合作

维护者欢迎任何合作。

如果您有建议，请通过以下联系方式发送电子邮件或在此存储库的问题跟踪器中留下问题。

但您能为我们所做的最好的事是为我们创建一个Pull Request！

联系方式