senic.cryptoyaml 0.1.1

API使用方法

这里有一个简单的示例

>>> from senic.cryptoyaml import generate_key, CryptoYAML
>>> new_key = generate_key('secret')
>>> config = CryptoYAML('/path/to/settings.yml.aes', keyfile=new_key)

最初，你必须生成一个密钥（它使用来自 cryptography 库的 Fernet对称加密），并使用它来构造一个CryptoYAML实例。

该实例提供了一个 data 属性，最初是一个空字典，你可以填充任意数据，前提是 PyYAML 库可以对其进行编码

>>> config.data['foo'] = 123

然而，请注意，只有当你像这样明确地将数据提交到磁盘时，数据才会持久化在文件系统上

>>> config.write()

一旦写入，只要原始的秘密仍然提供，就可以重新读取该文件

>>> reread = CryptoYAML('/path/to/settings.yml.aes', keyfile=new_key)
>>> reread.data['foo']
>>> 123

命令行使用

拥有加密设置文件很方便，但有时你可能想从命令行查看它或操作它，而不是通过编程方式。

对于这个 cryptoyaml，有三个命令用于生成密钥、创建新文件、读取文件和设置单个设置

# cryptoyaml generate_key mysecret
Created new private key at /Users/senic/Development/senic.cryptoyaml/mysecret
# cryptoyaml create mysettings.yml.aes --keyfile mysecret
created new file at /Users/senic/Development/senic.cryptoyaml/mysettings.yml.aes
# cryptoyaml set mysettings.yml.aes foo bar --keyfile mysecret
foo -> bar
# cryptoyaml cat mysettings.yml.aes --keyfile mysecret
{'foo': 'bar'}

环境变量

通常的做法是通过环境变量提供密钥。只需设置 CRYPTOYAML_SECRET，就可以在API使用和命令行中省略密钥。

0.1.1 (2017-01-03)

外观棕色袋发布…

0.1.0 (2016-12-20)

变更

初始发布。