aboutcode-org / aboutcode-org/scancode-toolkit

No documentation on calling ScanCode as a library

Ouverte
#3,130 4 commentaires 2 réactions 0 personnes assignées Voir sur GitHub
documentation Priority: medium
Langage dominant
Python
Étoiles
2.6k
Forks
791
Merge moyen
1 j 12 h
PR mergées (30 j)
5

Description

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

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.