AutoReviewer

科学家经常做同样不好的事情。自动化Python包同行评审期间的反馈。

目标

1. 给定一个GitHub存储库，自动化查找常见问题，例如
   • 没有 setup.py/setup.cfg/pyproject.toml
   • 没有从README链接到zenodo存档
   • 非标准代码布局（如src/或破坏）
   • 文件包含硬编码的文件路径
   • 没有文档（在README中搜索readthedocs的链接）
   • 包名与GitHub存储库名不匹配
   • 没有可重现的安装说明（即，README是否包含pip）
   • 使用conda进行安装
   • 代码风格不一致（例如，没有为black配置）
   • pyroma未通过10/10
   • 缺少LICENSE文件
   • 缺少CITATION.cff文件
2. 自动化将问题发送到存储库，说明如何做这些事情
   • 为所有问题使用确定的标题以避免重复/使幂等
   • 创建和编辑“史诗”问题以链接其他问题

示例审查

• https://github.com/fanavarro/lexical-analysis-obo-foundry/issues/4
• https://github.com/krishnanlab/PecanPy/issues/12
• https://github.com/huihui1126/drugSim-pathway/issues/14

想要合作吗？您对Python包有什么期望？请在评论区告诉我。我想象这是一个模块化的东西，人们可以贡献他们自己的检查。

期望的接口

通过命令行运行

$ autoreviewer https://github.com/rs-costa/sbml2hyb

J. Chem. Inf. Analysis

有一个子模块 autoreviewer.jcheminf，它提供了从《化学信息杂志》抓取论文列表、获取它们的ePub文件、从可用性声明中提取GitHub引用、对每个文件运行自动评审，然后使用 python -m autoreviewer.jcheminf 生成以下摘要的实用工具。

🚀 安装

最新版本可以从 PyPI 使用以下命令安装：

$ pip install autoreviewer

最新代码和数据可以直接从GitHub安装

$ pip install git+https://github.com/cthoyt/autoreviewer.git

您还需要确保已安装 pandoc。在macOS上，最好的方法是使用 brew install pandoc。

👐 贡献

贡献，无论是提交问题、创建拉取请求还是进行分支操作，都受到欢迎。有关参与的信息，请参阅 CONTRIBUTING.md。

👋 致谢

⚖️ 许可证

本包中的代码受MIT许可证许可。

🍪 Cookiecutter

此包是用 @audreyfeldroy 的 cookiecutter 包和 @cthoyt 的 cookiecutter-snekpack 模板创建的。

🛠️ 开发者

$ git clone git+https://github.com/cthoyt/autoreviewer.git
$ cd autoreviewer
$ pip install -e .

$ tox

$ git clone git+https://github.com/cthoyt/autoreviewer.git
$ cd autoreviewer
$ tox -e docs
$ open docs/build/html/index.html

$ tox -e finish