🚢 Authorship 🚢

格式化学术文本和期刊投稿中的作者列表。

🕵️ 为什么会有这个存在？

维护协作学术工作中的作者列表有点麻烦。我们中很多人开始使用Google Sheets来收集作者信息，因为它允许人们输入自己的信息，如ORCID和所属机构。我想自动化将那些表格转换为可以复制粘贴到我的论文（例如，在Google Docs或LaTeX中）的某些有用表格以及投稿表格（例如，bioRxiv上的批量作者TSV文件导入）。

💪 开始使用

此示例显示从Google Sheets加载一个标准电子表格，随后以美观的文本格式打印出来，在bioRxiv批量导入格式中，以及用于提交给《自然科学数据》的LaTeX格式。

from authorship.readers import GoogleSheetReader
from authorship.writers import BiorxivWriter, ScientificDataWriter, TextWriter

# Standard google sheet
reader = GoogleSheetReader("1Fo1YH3ZzOVrQ4wzKnBm6sPha5hZG66-u-uSMDGUvguI")
TextWriter().print(reader)
BiorxivWriter().print(reader)
ScientificDataWriter().print(reader)

可以使用 class-resolver 包作为快捷方式，根据名称访问编写者。它很智能，可以识别大小写、间距和标点符号，因此您无需担心那么多导入。以下示例与上一个示例执行相同的操作。

from authorship.readers import GoogleSheetReader

reader = GoogleSheetReader("1Fo1YH3ZzOVrQ4wzKnBm6sPha5hZG66-u-uSMDGUvguI")
reader.print("text")
reader.print("biorxiv", file="~/Desktop/bioregistry_authors_biorxiv.tsv")
reader.print("scientific data")
reader.print("citation cff")

下一个示例显示了从 Google Sheets 加载 OBO 社区风格的电子表格。这已被用于 SSSOM、ODK、细胞本体和几篇其他论文。

from authorship.readers import OboGoogleSheetReader

# OBO community-flavored google sheet
reader = OboGoogleSheetReader(
   "1NfhibWHOKgV2glmgRdKMzHEzTCw2_dUq_t0Zq64cgeQ",
   skiprows=1,
)
reader.print("text")
reader.print("biorxiv", file="~/Desktop/sssom_authors_biorxiv.tsv")
reader.print("scientific data")

🐇 扩展

您可以通过继承 authorship.readers.Reader 类并实现 get_authorship() 函数来自定义自己的读取器子类。

同样，您可以通过继承 authorship.writers.Writer 类并实现 iter_lines() 函数来自定义自己的写入器。

我们很高兴接受新的插件，特别是有助于自动生成各种期刊特定 LaTeX 模板的 LaTeX。

🚀 安装

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

$ pip install authorship

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

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

👐 贡献

无论您是提交问题、提交拉取请求还是进行分叉，我们都感谢您的贡献。有关参与的更多信息，请参阅 CONTRIBUTING.md。

👋 致谢

⚖️ 许可证

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

🍪 Cookiecutter

此包使用 @audreyfeldroy 的 cookiecutter 包以及 @cthoyt 的 cookiecutter-snekpack 模板创建。

🛠️ 对于开发者

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

$ tox

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

$ tox -e finish