# Library Analyzer
[![PyPI](https://img.shields.io/pypi/v/library-analyzer)](https://pypi.org/project/library-analyzer)
[![Main](https://github.com/Safe-DS/Library-Analyzer/actions/workflows/main.yml/badge.svg)](https://github.com/Safe-DS/Library-Analyzer/actions/workflows/main.yml)
[![codecov](https://codecov.io/gh/Safe-DS/Library-Analyzer/branch/main/graph/badge.svg?token=UyCUY59HKM)](https://codecov.io/gh/Safe-DS/Library-Analyzer)
[![Documentation Status](https://readthedocs.org/projects/library-analyzer/badge/?version=latest)](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
Get the latest version from [PyPI](https://pypi.org/project/library-analyzer):
```shell
pip install library-analyzer
```
## Example usage
1. Analyze the API of a library:
```shell
analyze-library api -p sklearn -o out
```
2. Analyze client code of a library:
```shell
analyze-library usages -p sklearn -c "Kaggle Kernels" -o out
```
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 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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Safe-DS/Library-Analyzer",
"name": "library-analyzer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<3.12",
"maintainer_email": "",
"keywords": "static-analysis,library,client-code",
"author": "Lars Reimann",
"author_email": "mail@larsreimann.com",
"download_url": "https://files.pythonhosted.org/packages/85/91/672862ddb2390adeec859253105bf222b67431f057abb87783b30d843e45/library_analyzer-0.1.1.tar.gz",
"platform": null,
"description": "# Library Analyzer\n\n[![PyPI](https://img.shields.io/pypi/v/library-analyzer)](https://pypi.org/project/library-analyzer)\n[![Main](https://github.com/Safe-DS/Library-Analyzer/actions/workflows/main.yml/badge.svg)](https://github.com/Safe-DS/Library-Analyzer/actions/workflows/main.yml)\n[![codecov](https://codecov.io/gh/Safe-DS/Library-Analyzer/branch/main/graph/badge.svg?token=UyCUY59HKM)](https://codecov.io/gh/Safe-DS/Library-Analyzer)\n[![Documentation Status](https://readthedocs.org/projects/library-analyzer/badge/?version=latest)](https://library-analyzer.safe-ds.com)\n\nAnalysis of Python libraries and code that uses them.\n\n## Documentation\n\nYou can find the full documentation [here](https://library-analyzer.safe-ds.com).\n\n## Installation\n\nGet the latest version from [PyPI](https://pypi.org/project/library-analyzer):\n\n```shell\npip install library-analyzer\n```\n\n## Example usage\n\n1. Analyze the API of a library:\n ```shell\n analyze-library api -p sklearn -o out\n ```\n2. Analyze client code of a library:\n ```shell\n analyze-library usages -p sklearn -c \"Kaggle Kernels\" -o out\n ```\n3. Generate annotations for the library:\n ```shell\n analyze-library annotations -a data/api/sklearn__api.json -u data/usages/sklearn__usage_counts.json -o out/annotations.json\n ```\n4. Migrate annotations for a new version of the library:\n ```shell\n 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\n ```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Analysis of Python libraries and code that uses them.",
"version": "0.1.1",
"split_keywords": [
"static-analysis",
"library",
"client-code"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d4809472d3cbef2acbc1bcc10cd090e7f3e3bdebf0e87a53951a4b7eacbbd701",
"md5": "8b367770125d466670ed42d30fb23700",
"sha256": "deef4869db833dfc53e287db45830723c63f15dc519b40196f32de857519575f"
},
"downloads": -1,
"filename": "library_analyzer-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b367770125d466670ed42d30fb23700",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<3.12",
"size": 125874,
"upload_time": "2023-03-19T16:38:03",
"upload_time_iso_8601": "2023-03-19T16:38:03.150402Z",
"url": "https://files.pythonhosted.org/packages/d4/80/9472d3cbef2acbc1bcc10cd090e7f3e3bdebf0e87a53951a4b7eacbbd701/library_analyzer-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8591672862ddb2390adeec859253105bf222b67431f057abb87783b30d843e45",
"md5": "feec7001970a7729cdbdbfb36a5089b3",
"sha256": "497dd8da453559558227361d6065f142833e55be616bded04e27743a9e8a33ad"
},
"downloads": -1,
"filename": "library_analyzer-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "feec7001970a7729cdbdbfb36a5089b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<3.12",
"size": 94633,
"upload_time": "2023-03-19T16:38:04",
"upload_time_iso_8601": "2023-03-19T16:38:04.651226Z",
"url": "https://files.pythonhosted.org/packages/85/91/672862ddb2390adeec859253105bf222b67431f057abb87783b30d843e45/library_analyzer-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-19 16:38:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Safe-DS",
"github_project": "Library-Analyzer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "library-analyzer"
}