aboutcode-org / aboutcode-org/scancode-toolkit

No documentation on calling ScanCode as a library

未关闭
#3,130 4 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看
documentation Priority: medium
主要语言
Python
星标
2.6k
派生
791
平均合并
1 天 12 小时
30 天内合并 PR
5

描述

### Description

The ScanCode documentation mentions that it is possible to use it as a Python library, which is great when you want to use it from a Python script. It includes instructions to install it as a library: https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html#installation-as-a-library-via-pip However, after that, there is zero documentation available on how to _use_ it as a library, making that choice not very practical.

Just a reference section on the Python API of ScanCode would already be a big improvement over digging through the source. Or, if you folks don't want to support that way of using it, then removing the section of the doc that lists that as a possibility would be a good idea. Thanks!

### Select Category

- [ ] Inconsistency
- [ ] New Section Request
- [x] General Improvement
- [ ] Typo/Mistakes
- [ ] Other

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。