在pypi包中包含用户可编辑配置文件的最佳方法？

Question

我有一个使用配置文件的命令行python脚本。我打算很快将它放在pypi上。

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

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

另一个选项是要求用户将配置文件的位置指定为命令行arg。我想这没关系，但它让用户有责任转到文档并从头开始创建整个配置文件。

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

谢谢！

-Travis

Answer 1

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

除非你有项目的概念，否则我不认为Django方法会有效。

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

Answer 2

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