python - 在公共(public) git repo 上对 python 应用程序进行版本控制时保护私有(private) API key 的正确方法

Question

我想在 Github 上开源一个 python 项目，但它包含一个不应分发的 API key 。
我想有什么比每次向 repo 提交“推送”时删除 key 更好的方法。

想象一个简化的 foomodule.py :

import urllib2
API_KEY = 'XXXXXXXXX'
urllib2.urlopen("http://example.com/foo?id=123%s" % API_KEY ).read()

我的想法是:

1. 将 API_KEY 移动到第二个 key.py 模块中，将其导入 foomodule.py；然后我会在 .gitignore 文件上添加 key.py。

2. 与 1. 相同，但使用 ConfigParser

您知道处理这种情况的任何好的编程方法吗？

Answer 1

有一个版本控制模板key_template.py:

domain = 'example.com'
API_KEY = 

检查到本地机器，填写敏感字段(例如API_KEY)并保存为key.py。忽略版本控制软件中的 key.py。将它保存在 Python 文件中或使用 ConfigParser 真的没有关系。

自动方式可能是在更新时自动合并现有的 key.py 文件。