科学软件的引用解析器和Markdown语言。
项目描述
CiteLang
欢迎使用CiteLang！CiteLang提供方法和基于图建模来研究软件生态系统。您可以使用CiteLang进行您的科研，或使用提供的工具生成软件图元数据，包括（但不限于）
- 生成基本的软件信用树（citelang图、徽章或Markdown信用）
- 为依赖项进行信用核算！（见software-credit.md）
- 对上述功能进行操作（自动化）！
对于上述示例，我们没有使用DOI！一个需要人工记忆的手动制作的标识符，除了一篇论文或发布，对人们来说工作量太大，无法合理完成。作为研究软件工程师，我们还想摆脱传统的“像学者一样被重视”的模式。我们通过包管理器获取软件元数据和标识符的引用。这意味着当您发布软件时，您应该将其发布到适当的包管理器。
入门
如果您想将CiteLang用作分析库，请跳转到更详细的⭐️ 文档 ⭐️ 或查看特定的Python API。作为一个示例分析，RSEPedia软件生态系统是一个完成的自动化设置，每周解析和总结研究软件百科全书中的依赖关系，并由CiteLang提供支持！您可以使用CiteLang进行类似的分析或构建自己的工具。我们将在这里简要介绍可用的工具。
徽章
CiteLang 徽章可以显示项目的整个信用树
或可以生成交互式网页界面，如此处所示。
请参阅徽章文档，了解更多自定义外观或抽象级别的示例。您可以使用提供的GitHub Action自动生成或更新您的存储库徽章。
信用和图形
如果您想可视化显示依赖关系图，使用信用将打印到控制台，并可选地以json格式打印，如果您只想有数据。使用图形命令，您可以使用相同的数据渲染不同类型的漂亮图形（或数据格式dot、cypher、gexf）。
贡献
CiteLang有一个Contrib命令和底层API，可以深入到您的git历史中，并查看基于行的贡献。您可以在这篇博客文章中阅读完整的说明和示例。它目前正在由SingularityCE项目使用，以感谢贡献者！
如果您想以编程方式生成数据，我们提供了GitHub Action。
渲染和生成
最初源于名称的功能——一个“引用的Markdown语法”意味着我们可以从一个包含一些CiteLang格式引用的Markdown论文开始，并生成一个包含信用表的渲染后的论文。这是使用渲染命令完成的，或者您可以使用生成将表格输出到其自己的Markdown文件中。我们提供了一个示例，并提供了一个GitHub Action，供您为自己的存储库生成此文件。
贡献者
我们使用all-contributors工具生成下面的贡献者图形。
 Vanessasaurus 💻 |
 Dave Trudgian 💻 |
 Traceton 💻 |
许可证
此代码根据MPL 2.0 授权。
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解有关安装包的更多信息。