lsst-dochub-proto 0.0.2

使用方法

#/usr/bin/env python
from dochubproto import DocHubProto

p = DocHubProto()
idx = p.render_index()

配置

DocHubProto 使用以下环境变量

• KEEPER_URL (默认 https://keeper.lsst.codes).

• LOGLEVEL (默认 WARNING).

• TEMPLATE_DIR: 包含 Jinja2 模板的目录 (默认 templates).

• UL_TEMPLATE_NAME: 单个文档项模板的相对路径 (默认 doclist.jinja2).

• IDX_TEMPLATE_NAME: index.html 模板的相对路径 (默认 index.jinja2).

• MAX_DOCUMENT_DATA_AGE: 文档的最大缓存时间（以秒为单位）(默认 3600).

DocHubProto API概述

• check_state() 返回以下之一

  • STATE_EMPTY ('empty')

  • STATE_READY ('ready')

  • STATE_REFRESHING ('refreshing')

  • STATE_STALE ('stale')

  如果文档的日期早于MAX_DOCUMENT_DATA_AGE，则该文档被认为是“过时”的。

• get_document_data() 和 get_fresh_document_data() 返回一个字典，其键为文档部分（例如 DMTN），在每一部分中，文档句柄（例如 dmtn-038）按顺序排列的列表。

• render() 返回一个由文档数据创建的 HTML 无序列表实体，编码为 UTF-8。

• render_index() 返回一个由文档数据创建的 HTML 文档，编码为 UTF-8。

• debug()、info()、warning()、error() 和 critical() 分别以指定级别记录一条消息；它使用 structlog 记录器通过 apikit 记录 JSON 输出。