Skip to content

osslab-pku/RecLicense

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LicenseRec

这是北京大学开源分析实验室研发的工具,以帮助开源许可证的选择.

Image text

简介

LicenseRec是一个开源许可证推荐工具,帮助开发者为他们的开源软件项目选择一个最佳许可证。 LicenseRec对开源软件项目的代码和依赖关系进行细粒度的许可证兼容性检查,并通过一个交互式的向导来帮助开发者选择最佳的许可证,该向导有三个方面的指引:个人开放源码风格、商业模式和社区发展。

该工具可在licenserec.com使用,演示视频在video.licenserec.com。该工具已发表在ICSE'23的DEMO Track上,论文参见:LicenseRec: Knowledge based Open Source License Recommendation for OSS Projects.

快来上传你的项目,在licenserec.com上挑选最佳的开源许可证吧!

安装

LicenseRec可以通过两种方式安装:使用Docker或手动。查看DEPLOY.md中的部署说明。

知识库

开源许可证知识库(knowledge_base)文件夹下,包含了开源许可证兼容性矩阵、条款特征矩阵、兼容性判定方法等资料。包括为机器阅读而建立的文件(即本工具的输入),以及为人类理解而建立的文件(具有更多的解释)。

许可证和鸣谢

LicenseRec是根据木兰公共许可证v2授权的。详情见LICENSE

LicenseRec依赖于以下开源项目。

引用

@INPROCEEDINGS{licenserec,
  author={Xu, Weiwei and Wu, Xin and He, Runzhi and Zhou, Minghui},
  booktitle={2023 IEEE/ACM 45th International Conference on Software Engineering: Companion Proceedings (ICSE-Companion)}, 
  title={LicenseRec: Knowledge based Open Source License Recommendation for OSS Projects}, 
  year={2023},
  pages={180-183},
  doi={10.1109/ICSE-Companion58688.2023.00050}}

Introduction

LicenseRec is an open source license recommendation tool that helps developers choose a optimal license for their OSS project. LicenseRec performs fine-grained license compatibility checks on OSS projects’ code and dependencies, and assists developers to choose the optimal license through an interactive wizard with guidelines of three aspects: personal open source style, business pattern, and community development.

The tool is available at licenserec.com and the demonstration video is at video.licenserec.com.The tool has been published in the DEMO Track of ICSE'23, see the paper: LicenseRec: Knowledge based Open Source License Recommendation for OSS Projects.

Upload your project and pick the best open source license on licenserec.com!

Installation

LicenseRec can be installed in two ways: using Docker or manually. Check deployment instructions in DEPLOY.md.

Knowledge base

The knowledge_base folder contains information on open source license compatibility matrix, term feature matrix, compatibility judgment method, and so on. There are two groups of files: files for machine reading (i.e, input for this tool), and files for human understanding (with more explanation about license compatibility).

License and Acknowledgements

LicenseRec is licensed under MulanPubL-2.0. See LICENSE for details.

LicenseRec relies on the following open source projects:

Citation

For citing, please use following BibTex citation:

@INPROCEEDINGS{licenserec,
  author={Xu, Weiwei and Wu, Xin and He, Runzhi and Zhou, Minghui},
  booktitle={2023 IEEE/ACM 45th International Conference on Software Engineering: Companion Proceedings (ICSE-Companion)}, 
  title={LicenseRec: Knowledge based Open Source License Recommendation for OSS Projects}, 
  year={2023},
  pages={180-183},
  doi={10.1109/ICSE-Companion58688.2023.00050}}