yaml2down 0.1.8

# Yamldown

此库允许用户加载和读取“YAMLdown”文件。即Markdown（主要用于GitHub）中嵌入YAML。GitHub Markdown已经将Markdown中的YAML风格文本渲染为表格。此库将yamldown文件解析为其相应的YAML和Markdown。

## 安装

pip install yaml2down

对于本地安装和开发，您可以运行make文件

sauron@orthanc:[~]$ cd yaml2down sauron@orthanc:[yaml2down]$ make

这将创建一个虚拟环境env，安装requirements.txt和setup.py中的所有内容，运行测试，并运行mypy，Python 3的类型检查器。在本地开发时请务必激活虚拟环境

source env/bin/activate

或

. env/bin/activate

要取消激活虚拟环境，只需运行命令deactivate

## 使用

导入yamldown模块将允许您加载和保存yamldown文件。load接收一个文件对象（由yamldown格式的文本支持）并返回一个元组，第一个是包含YAML的字典，第二个是Markdown内容的字符串。这样就可以使用yaml了。

示例

$ python3 >>> import io >>> import yamldown >>> s = “”” …— … things: … - hello … - world … foo: bar … — … 这是些Markdown文本””” >>> f = io.StringIO(s) >>> yml, md = yamldown.load(f) >>> print(yml) {'things': ['hello', 'world'], 'foo': 'bar'} >>>print(md) 这是些Markdown文本

要输出yamldown文件，dump接收一个包含您yaml数据的字典和一个Markdown字符串，并输出一个字符串。可以通过yamlfirst选项指定yaml在文档中的出现顺序：如果yaml应该出现在开头（如上述示例）则为True，如果出现在末尾则为False。

示例

Python 3 >>> 导入 yamldown >>> yml = {'things': ['hello', 'world'], 'foo': 'bar'} >>> md = "This is some markdown text" >>> 打印(yamldown.dump(yml, md)) — foo: bar things: - hello - world

— This is some markdown text