pymport 0.0.1

A lightweight Python linter for checking unused docstrings.

pymport

About

A lightweight Python linter for checking unused imports

Features

This tool tries to identify unused imports in a single module. This task is not possible to assure a 100% false positive free result due to the possible collateral execution effects when importing a module. This is, importing a module can affect or enable some feature needed somewhere else, so not using anything from that imported package/module does not necessarily mean is not needed.

A minimal typical example could be:

import os.path

print(os.curdir)

Installation

To install pymport using pip, run the following command:

pip install pymport --upgrade

Quick Start

You can run the linter from the CLI using the following syntax:

pymport [FILE] [--help]

Argument / Option	Description
[FILE]	Files or directories to lint. (Need at least one file or dir to check.)
--help	Show help message and exit.

[!TIP] Ignoring Unused Imports

Use a comment like # noqa: unused-import to ignore the line.

Development

To contribute to the project, you can run the following commands for testing and documentation:

First, ensure you have the latest version of pip:

python -m pip install --upgrade pip

Running Tests

pip install --group=test --upgrade # Install test dependencies, skip if already installed
python -m pytest tests/ # Run all tests
python -m pytest tests/ --cov # Run tests with coverage

Running Linter

pip install --group=lint --upgrade  # Install lint dependencies, skip if already installed
ruff check . # Run linter

License

This project is licensed under the MIT license.