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

Question

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

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

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

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

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

谢谢！

-特拉维斯

Answer 1

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

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

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

Answer 2

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