aboutcode-org / aboutcode-org/scancode-toolkit

No documentation on calling ScanCode as a library

Đang mở
#3,130 4 bình luận 2 reaction 0 người được giao Xem trên GitHub
documentation Priority: medium
Ngôn ngữ chính
Python
Star
2.6k
Fork
791
Merge trung bình
1 ngày 12 giờ
Pull request đã merge (30 ngày)
5

Mô tả

### 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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.