Skip to content
generated from tweag/project

FawltyDeps GitHub Action to lint packages for undeclared or unused 3rd-party dependencies

License

Notifications You must be signed in to change notification settings

tweag/FawltyDeps-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Code of conduct

FawltyDeps GitHub Action

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.

Table of contents

Key Concepts

Usage

Inputs

Outputs

Example usage

Documentation

Development

Key Concepts

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

Usage

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.

Inputs

options

Optional command line arguments to fawltydeps.

Example usage

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.

Documentation

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

Development

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.