Skip to content
This repository has been archived by the owner on Nov 23, 2024. It is now read-only.

Safe-DS/Library-Analyzer

Repository files navigation

Library Analyzer

Project status: The development of a proof-of-concept implementation is done. We are currently focussing our attention on other projects.

PyPI Main codecov Documentation Status

Analysis of Python libraries and code that uses them.

Installation

Get the latest version from PyPI:

pip install library-analyzer

Example usage

  1. Analyze the API of a library:
    analyze-library api -p sklearn -o out
  2. Analyze client code of a library:
    analyze-library usages -p sklearn -c "Kaggle Kernels" -o out
  3. Generate annotations for the library:
    analyze-library annotations -a data/api/sklearn__api.json -u data/usages/sklearn__usage_counts.json -o out/annotations.json
  4. Migrate annotations for a new version of the library:
    analyze-library migrate -a1 data/api/scikit-learn_v0.24.2_api.json -a2 data/api/sklearn__apiv2.json -a data/annotations/annotations.json -o out

Documentation

You can find the full documentation here.

Contributing

We welcome contributions from everyone. As a starting point, check the following resources:

If you need further help, please use our discussion forum.