向python包添加引用建议的首选方法是什么？

Question

除了文档中的内容外，开发人员应如何指示用户应如何引用该软件包？

R程序包使用citation("pkg")返回首选引用。

我可以想到pkg.CITATION，pkg.citation和pkg.__citation__。还有其他吗？如果没有首选的方法（在我看来情况如此，因为我在python.org上找不到任何东西），每种方法的优缺点是什么？

Answer 1

最后，我选择了dunder选项。只有dunder选项（__citation__）清楚表明，这不是运行时所需的普通变量。

是的，dunder字符串不应该用于通货膨胀，因为python可能会在以后使用它们。但是，如果python要使用__citation__，那么它将用于类似目的。另外，我认为其他选择的相对成本更高。