python-inspector - inspect Python packages dependencies and metadata
=====================================================================
Copyright (c) nexB Inc. and others.
SPDX-License-Identifier: Apache-2.0
Homepage: https://github.com/aboutcode-org/python-inspector and https://www.aboutcode.org/
``python-inspector`` is a collection of utilities to:
- resolve PyPI packages dependencies
- parse various requirements.txt files and setup.py files as input
for resolving dependencies.
- parse additionally various manifests and packages files such as
Pipfile, pyproject.toml, poetry.lock and setup.cfg and legacy and
current metadata file formats for eggs, wheels and sdist. These
have not been wired with the command line yet.
- query PyPI JSON and simple APIs for package information
It grew out of ScanCode toolkit to find and analyze PyPI archives and
installed Python packages and their files.
The goal of python-inspector is to be a comprehensive library
that can handle every style of Python package layouts, manifests and lockfiles.
Testing
--------
- Run the tests with::
pytest -vvs
- These are live tests to regenrate the tests with updated data run::
PYINSP_REGEN_TEST_FIXTURES=yes pytest -vvs
Usage
--------
- Install with pip::
pip install git+https://github.com/aboutcode-org/python-inspector
- Run the command line utility with::
python-inspector --help
Its companion libraries are:
- ``pip-requirements-parser``, a mostly correct pip requirements parsing
library extracted from pip.
- ``pkginfo2``, a safer fork of pkginfo to parse various installed and extracted
package layouts and their metadata files.
- ``dparse2``, a safer fork of dparse to parse various package manifests
- ``resolvelib``, the library used by pip for dependency resolution
- ``packaging``, the official Python packaging utility library to process
versions, specifiers, markers and other packaging data formats.
- ``importlib_metadata``, the official Python utility library to process
installed site-packages and their metadata formats.
- ``packageurl-python`` to use Package URL to reference Python packages
Raw data
{
"_id": null,
"home_page": "https://github.com/aboutcode-org/python-inspector",
"name": "python-inspector",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "open source, scan, package, dependency, pypi, python, SBOM, sca, dependencies, dependency resolution, resolver, resolvelib, pip, requirements",
"author": "nexB. Inc. and others",
"author_email": "info@aboutcode.org",
"download_url": "https://files.pythonhosted.org/packages/a6/d8/427aa551d9199d688e56d998a13129a531e77b05247ba1d29d2178b42b87/python_inspector-0.12.1.tar.gz",
"platform": null,
"description": "python-inspector - inspect Python packages dependencies and metadata\n=====================================================================\n\n\nCopyright (c) nexB Inc. and others.\nSPDX-License-Identifier: Apache-2.0\nHomepage: https://github.com/aboutcode-org/python-inspector and https://www.aboutcode.org/\n\n\n``python-inspector`` is a collection of utilities to:\n\n- resolve PyPI packages dependencies\n\n- parse various requirements.txt files and setup.py files as input\n for resolving dependencies.\n\n- parse additionally various manifests and packages files such as\n Pipfile, pyproject.toml, poetry.lock and setup.cfg and legacy and\n current metadata file formats for eggs, wheels and sdist. These\n have not been wired with the command line yet.\n\n- query PyPI JSON and simple APIs for package information\n\nIt grew out of ScanCode toolkit to find and analyze PyPI archives and\ninstalled Python packages and their files.\n\nThe goal of python-inspector is to be a comprehensive library\nthat can handle every style of Python package layouts, manifests and lockfiles.\n\n\nTesting\n--------\n\n- Run the tests with::\n\n pytest -vvs\n\n- These are live tests to regenrate the tests with updated data run::\n\n PYINSP_REGEN_TEST_FIXTURES=yes pytest -vvs\n\nUsage\n--------\n\n- Install with pip::\n\n pip install git+https://github.com/aboutcode-org/python-inspector\n\n- Run the command line utility with::\n\n python-inspector --help\n\n\n\nIts companion libraries are:\n\n- ``pip-requirements-parser``, a mostly correct pip requirements parsing\n library extracted from pip.\n\n- ``pkginfo2``, a safer fork of pkginfo to parse various installed and extracted\n package layouts and their metadata files.\n\n- ``dparse2``, a safer fork of dparse to parse various package manifests\n\n- ``resolvelib``, the library used by pip for dependency resolution\n\n- ``packaging``, the official Python packaging utility library to process\n versions, specifiers, markers and other packaging data formats.\n\n- ``importlib_metadata``, the official Python utility library to process\n installed site-packages and their metadata formats.\n\n- ``packageurl-python`` to use Package URL to reference Python packages\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "python-inspector is is a collection of utilities to collect PyPI package metadata and resolve packages dependencies.",
"version": "0.12.1",
"project_urls": {
"Homepage": "https://github.com/aboutcode-org/python-inspector"
},
"split_keywords": [
"open source",
" scan",
" package",
" dependency",
" pypi",
" python",
" sbom",
" sca",
" dependencies",
" dependency resolution",
" resolver",
" resolvelib",
" pip",
" requirements"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "09901102499482ba334e9e4c18273c1f671d74da8c30afe5b5217ad5ceeaf507",
"md5": "c97520c3f72cb87bb525b87aaa01dfa0",
"sha256": "ff115623c9cf6b67f49e6083152a3ce7531b4951dbeda2f814b90f7270689d21"
},
"downloads": -1,
"filename": "python_inspector-0.12.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c97520c3f72cb87bb525b87aaa01dfa0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 93056,
"upload_time": "2024-08-09T06:27:54",
"upload_time_iso_8601": "2024-08-09T06:27:54.264958Z",
"url": "https://files.pythonhosted.org/packages/09/90/1102499482ba334e9e4c18273c1f671d74da8c30afe5b5217ad5ceeaf507/python_inspector-0.12.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a6d8427aa551d9199d688e56d998a13129a531e77b05247ba1d29d2178b42b87",
"md5": "79d3e58a953eedd23a157e90e056970f",
"sha256": "7d63ba5dc3c6c330306d50f35110304effbc43e596c115d1ca97b6f329f0f4af"
},
"downloads": -1,
"filename": "python_inspector-0.12.1.tar.gz",
"has_sig": false,
"md5_digest": "79d3e58a953eedd23a157e90e056970f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1474090,
"upload_time": "2024-08-09T06:27:56",
"upload_time_iso_8601": "2024-08-09T06:27:56.273032Z",
"url": "https://files.pythonhosted.org/packages/a6/d8/427aa551d9199d688e56d998a13129a531e77b05247ba1d29d2178b42b87/python_inspector-0.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-09 06:27:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aboutcode-org",
"github_project": "python-inspector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "python-inspector"
}
JSON
