108 lines
4.6 KiB
Plaintext
108 lines
4.6 KiB
Plaintext
Metadata-Version: 2.4
|
|
Name: deptry
|
|
Version: 0.23.0
|
|
Classifier: Development Status :: 3 - Alpha
|
|
Classifier: Environment :: Console
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
Classifier: Topic :: Software Development :: Quality Assurance
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: 3.12
|
|
Classifier: Programming Language :: Python :: 3.13
|
|
Classifier: Programming Language :: Rust
|
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Requires-Dist: click >=8.0.0, <9
|
|
Requires-Dist: colorama >=0.4.6 ; sys_platform == 'win32'
|
|
Requires-Dist: packaging >=23.2
|
|
Requires-Dist: requirements-parser >=0.11.0, <1
|
|
Requires-Dist: tomli >=2.0.1 ; python_version < '3.11'
|
|
License-File: LICENSE
|
|
Summary: A command line utility to check for unused, missing and transitive dependencies in a Python project.
|
|
Author-email: Florian Maas <fpgmaas@gmail.com>
|
|
Maintainer-email: Mathieu Kniewallner <mathieu.kniewallner@gmail.com>
|
|
Requires-Python: >=3.9
|
|
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
|
|
Project-URL: homepage, https://deptry.com
|
|
Project-URL: repository, https://github.com/fpgmaas/deptry
|
|
Project-URL: documentation, https://deptry.com
|
|
Project-URL: changelog, https://github.com/fpgmaas/deptry/blob/main/CHANGELOG.md
|
|
|
|
<p align="center">
|
|
<img alt="deptry logo" width="460" height="300" src="https://raw.githubusercontent.com/fpgmaas/deptry/main/docs/static/deptry_Logo-01.svg">
|
|
</p>
|
|
|
|
[](https://pypi.org/project/deptry/)
|
|
[](https://github.com/fpgmaas/deptry/actions/workflows/main.yml)
|
|
[](https://pypi.org/project/deptry/)
|
|
[](https://codecov.io/gh/fpgmaas/deptry)
|
|
[](https://pypistats.org/packages/deptry)
|
|
[](https://img.shields.io/github/license/fpgmaas/deptry)
|
|
|
|
_deptry_ is a command line tool to check for issues with dependencies in a Python project, such as unused or missing
|
|
dependencies. It supports projects
|
|
using [Poetry](https://python-poetry.org/), [pip](https://pip.pypa.io/), [PDM](https://pdm-project.org/), [uv](https://docs.astral.sh/uv/),
|
|
and more generally any project supporting [PEP 621](https://peps.python.org/pep-0621/) specification.
|
|
|
|
Dependency issues are detected by scanning for imported modules within all Python files in a directory and its
|
|
subdirectories, and comparing those to the dependencies listed in the project's requirements.
|
|
|
|
---
|
|
<p align="center">
|
|
<a href="https://deptry.com">Documentation</a> - <a href="https://deptry.com/contributing/">Contributing</a>
|
|
</p>
|
|
|
|
---
|
|
|
|
## Quickstart
|
|
|
|
### Installation
|
|
|
|
To add _deptry_ to your project, run one of the following commands:
|
|
|
|
```shell
|
|
# Install with poetry
|
|
poetry add --group dev deptry
|
|
|
|
# Install with pip
|
|
pip install deptry
|
|
```
|
|
|
|
> **Warning**: When using pip to install _deptry_, make sure you install it within the virtual environment of your project. Installing _deptry_ globally will not work, since it needs to have access to the metadata of the packages in the virtual environment.
|
|
|
|
### Prerequisites
|
|
|
|
_deptry_ should be run within the root directory of the project to be scanned, and the project should be running in its own dedicated virtual environment.
|
|
|
|
### Usage
|
|
|
|
To scan your project for dependency issues, run:
|
|
|
|
```shell
|
|
deptry .
|
|
```
|
|
|
|
Example output could look as follows:
|
|
|
|
```console
|
|
Scanning 2 files...
|
|
|
|
foo/bar.py:1:0: DEP004 'numpy' imported but declared as a dev dependency
|
|
foo/bar.py:2:0: DEP001 'matplotlib' imported but missing from the dependency definitions
|
|
pyproject.toml: DEP002 'pandas' defined as a dependency but not used in the codebase
|
|
Found 3 dependency issues.
|
|
```
|
|
|
|
### Configuration
|
|
|
|
_deptry_ can be configured by using additional command line arguments, or by adding a `[tool.deptry]` section in _pyproject.toml_. For more information, see the [Usage and Configuration](https://deptry.com/usage/) section of the documentation..
|
|
|
|
---
|
|
|
|
Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).
|
|
|