This FawltyDeps GitHub Action lints packages for undeclared or unused 3rd-party dependencies.

See more about FawltyDeps:

FawltyDeps is a dependency checker for Python that finds undeclared and/or unused 3rd-party dependencies in your Python project. The name is inspired by the Monty Python-adjacent Fawlty Towers sitcom.

Key Concepts

Usage

Inputs

Outputs

Example usage

Documentation

Development

This allows you to run FawltyDeps as part of an independent GitHub action.

This action will run fawltydeps in the project directory for a Python codebase. See the FawltyDeps - Configuration documentation for more on how to configure this tool.

Optional command line arguments to fawltydeps.

You need to use a checkout action before the FawltyDeps action.

Simple usage:

steps:
  - uses: actions/checkout@v4
  - uses: tweag/FawltyDeps-action@v0.1.0

More advanced example with customized command line options:

steps:
  - name: checkout
    uses: actions/checkout@v4
  - name: fawltydeps lint
    uses: tweag/FawltyDeps-action@v0.1.0
    with:
      options: --list-sources --list-imports --list-deps --detailed

Invoking FawltyDeps Using options: --detailed yields good results when you just want to see what problems may be present.

This action was inspired by and partially derived from the MIT-licensed black and isort-action GitHub actions.

For details on setting up your development environment, please refer to the contributing guidelines of how to set up your development environment in our CONTRIBUTING.md file.