简单的文件元数据。
caput的Python项目详细描述
简单的文件元数据。在
将元数据存储在文本文件的特殊YAML配置头中,或 二进制文件的sidecar“shadow”配置文件。在
Caput:n.拉丁语,表示“head”或“top”。许多英语单词的词根,如 “船长”、“首都”和“斩首”。在
安装
Caput可从PyPI获得:
pip install caput
使用
假设您正在构建一个静态站点生成器。可以添加元数据标头 任何文本文件。前三个字节必须为---\n。在index.md:
^{pr2}$读取元数据标头:
>>> import caput >>> caput.read_config('./index.md', defaults={'markup': 'markdown'}) {'markup': 'markdown', 'title': 'My Site', 'author': 'Me', 'featured_image': '/images/my-header.jpg'}
阅读文件内容:
>>> caput.read_contents('./index.md') '# Welcome to my site!\n'
您可以使用“shadow”头将元数据添加到二进制文件中。为你的特色 image,添加一个具有相同基名称的.yml文件,例如for ./images/my-header.jpg您将添加./images/my-header.yml:
title: My Site Header credit: Me
读取元数据标头:
>>> caput.read_config('./images/my-header.jpg') {'title': 'My Site Header', 'credit': 'Me')
阅读文件内容:
>>> caput.read_contents('./images/my-header.jpg', encoding=None) b'...binary data...'
- 项目
标签: