This repository has been archived by the owner on Nov 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: badges & installation instructions
- Loading branch information
1 parent
78ebbf7
commit 4d137d1
Showing
1 changed file
with
18 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,39 @@ | ||
| # Library Analyzer | ||
|
|
||
| [](https://pypi.org/project/library-analyzer) | ||
| [](https://github.com/Safe-DS/Library-Analyzer/actions/workflows/main.yml) | ||
| [](https://codecov.io/gh/Safe-DS/Library-Analyzer) | ||
| [](https://library-analyzer.safe-ds.com) | ||
|
|
||
| Analysis of Python libraries and code that uses them. | ||
|
|
||
| ## Documentation | ||
|
|
||
| You can find the full documentation [here](https://library-analyzer.safe-ds.com). | ||
|
|
||
| ## Installation | ||
|
|
||
| 1. Install Python 3.10. | ||
| 2. Install [poetry](https://python-poetry.org/docs/master/#installation). | ||
| 3. **Only the first time**, install dependencies: | ||
| ```shell | ||
| poetry install | ||
| ``` | ||
| 4. Create a shell with poetry: | ||
| ```shell | ||
| poetry shell | ||
| ``` | ||
| Get the latest version from [PyPI](https://pypi.org/project/library-analyzer): | ||
|
|
||
| ```shell | ||
| pip install library-analyzer | ||
| ``` | ||
|
|
||
| ## Example usage | ||
|
|
||
| 1. Analyze an API: | ||
| 1. Analyze the API of a library: | ||
| ```shell | ||
| analyze-library api -p sklearn -o out | ||
| ``` | ||
| 2. Analyze client code of this API: | ||
| 2. Analyze client code of a library: | ||
| ```shell | ||
| analyze-library usages -p sklearn -c "Kaggle Kernels" -o out | ||
| ``` | ||
| 3. Generate annotations for the API: | ||
| 3. Generate annotations for the library: | ||
| ```shell | ||
| 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 API: | ||
| 4. Migrate annotations for a new version of the library: | ||
| ```shell | ||
| 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 | ||
| ``` |