在PyPI包中包含用户可编辑的配置文件的最佳方法是什么？

Question

我有一个使用配置文件的命令行python脚本。我打算很快把这个放在皮皮身上。在

在包中包含配置文件的默认版本，以便最终用户可以很明显地在哪里找到它，最好的通用方法是什么？在

包含用户可编辑配置文件的pypi项目的一个例子是Django。在Django中，用户必须运行脚本来初始化新项目。这将生成一个包含大量内容的目录，包括项目配置文件。然而，对于像我这样的简单命令行实用程序来说，这似乎是一种沉重的方法。在

另一个选项是要求用户将配置文件的位置指定为命令行参数。我想这是可以的，但是它让用户有责任去查看文档并从头开始创建整个配置文件。在

还有更好的选择吗？这方面有什么标准做法吗？在

谢谢！在

-特拉维斯

Answer 1

可以在脚本中包含默认值，然后允许用户使用命令行参数或用户主目录中的配置文件更改默认值。在

我不认为Django方法有效，除非你有一个项目的概念。在

如果这是在Unix上，如果脚本将由多个用户运行，我将把配置文件放在/etc中，或者作为dotfile放在用户的主文件夹中。这样，用户就不必每次都指定配置文件，但也可以使用命令行参数，让用户指定要使用的不同配置文件。在

Answer 2

我喜欢内森的回答。但是在这个特定的例子中，我最后在脚本中添加了一个命令行选项，它将把一个示例配置文件转储到标准输出。在