FawltyDeps

https://tweag.github.io/FawltyDeps
Admin
FawltyDeps is a dependency checker for Python that identifies undeclared and unused third-party...
Tokens:7,864
Snippets:141
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Development Dependencies with Poetry

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Install all development dependencies using Poetry. This creates a virtual environment with the necessary packages.

```bash
poetry install --with=dev

```

--------------------------------

### Install FawltyDeps as a standalone tool with uv

Source: https://tweag.github.io/FawltyDeps/installation

Install FawltyDeps as a standalone tool for general availability using uv.

```bash
uv tool install fawltydeps
```

--------------------------------

### Install FawltyDeps as a standalone tool with pipx

Source: https://tweag.github.io/FawltyDeps/installation

Install FawltyDeps as a standalone tool for general availability using pipx.

```bash
pipx install fawltydeps
```

--------------------------------

### Example generated configuration

Source: https://tweag.github.io/FawltyDeps/how_to_guides

The output format for the FawltyDeps configuration section in pyproject.toml.

```toml
[tool.fawltydeps]
# Default options are commented...
ignore_unused = ["black", "pylint"]
```

--------------------------------

### Activate Poetry Development Shell

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Activate the virtual environment created by Poetry to access installed dependencies.

```bash
poetry shell

```

--------------------------------

### Install FawltyDeps with pip

Source: https://tweag.github.io/FawltyDeps/installation

Install FawltyDeps using pip, the standard Python package installer.

```bash
pip install fawltydeps
```

--------------------------------

### Enter Nix Shell

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Enter a Nix shell environment that provides Poetry and all supported Python versions, isolating your system's Python installation.

```bash
nix-shell

```

--------------------------------

### Point FawltyDeps to a Python environment

Source: https://tweag.github.io/FawltyDeps/FAQ

Use the `--pyenv` option to specify a Python environment where dependencies like 'scikit-learn' are installed. This helps FawltyDeps correctly match import names (e.g., 'sklearn') with installed packages.

```bash
fawltydeps --pyenv=/path/to/your/venv/bin/python
```

--------------------------------

### Show Package Information with pip and uv

Source: https://tweag.github.io/FawltyDeps/DesignDoc

Use these commands to determine the list of transitive dependencies of a library. 'pip show' is the standard tool, while 'uv pip show' is a faster alternative.

```bash
pip show myLibrary
```

```bash
uv pip show myLibrary
```

```bash
poetry show
```

--------------------------------

### Generate configuration file

Source: https://tweag.github.io/FawltyDeps/how_to_guides

Create a [tool.fawltydeps] section for your pyproject.toml based on current CLI settings.

```bash
fawltydeps --generate-toml-config
```

--------------------------------

### Define a custom mapping in a TOML file

Source: https://tweag.github.io/FawltyDeps/explanation

Create a mapping file where keys are package names and values are lists of import names.

```toml
langchain-core = ["langchain_core"]
multiple-modules = ["module1", "module2"]
my-package = ["mpkg"]
python-dotenv = ["dotenv"]
scikit-learn = ["sklearn"]
```

--------------------------------

### Explicitly define code and dependency paths

Source: https://tweag.github.io/FawltyDeps/usage

Provides separate paths for source code and dependency files, equivalent to using a single search path argument.

```bash
fawltydeps --code my_project/ --deps my_project/
```

--------------------------------

### List Nox Sessions

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

List all available Nox sessions for running automated tasks and tests.

```bash
nox --list

```

--------------------------------

### Execute FawltyDeps with a custom mapping file

Source: https://tweag.github.io/FawltyDeps/explanation

Use the --custom-mapping-file flag to point to your TOML configuration.

```bash
fawltydeps --custom-mapping-file my_mapping.toml
```

--------------------------------

### Analyze code from stdin and files

Source: https://tweag.github.io/FawltyDeps/usage

Combines code piped from standard input with a specific file path for dependency analysis.

```bash
echo "import foo" | fawltydeps --list-imports --code - file.py
```

--------------------------------

### Generate detailed dependency report

Source: https://tweag.github.io/FawltyDeps/how_to_guides

Run a detailed analysis to identify the exact file and line number for undeclared dependencies.

```bash
fawltydeps --detailed
```

--------------------------------

### Check Formatting with Nox

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Check code formatting using ruff format via the 'format' Nox session.

```bash
nox -s format

```

--------------------------------

### Run All Nox Sessions

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Execute all available Nox sessions. This runs tests, linters, and format checks.

```bash
nox

```

--------------------------------

### Run Ruff Formatter Directly

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Apply code formatting using ruff format on the current directory. This command assumes the development environment is activated.

```bash
ruff format .

```

--------------------------------

### Configure pre-commit hook

Source: https://tweag.github.io/FawltyDeps/how_to_guides

Add FawltyDeps to your .pre-commit-config.yaml to automate dependency checks.

```yaml
repos:
  - repo: https://github.com/tweag/FawltyDeps
    rev: v0.20.0
    hooks:
      - id: check-undeclared
      - id: check-unused
```

--------------------------------

### Add FawltyDeps as a dev dependency with uv

Source: https://tweag.github.io/FawltyDeps/installation

Add FawltyDeps as a development dependency using the uv package manager.

```bash
uv add --dev fawltydeps
```

--------------------------------

### Run Nox Sessions Reusing Virtualenvs

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Run all Nox sessions while reusing virtual environments for faster execution.

```bash
nox -R

```

--------------------------------

### Monorepo directory structure

Source: https://tweag.github.io/FawltyDeps/how_to_guides

Visual representation of a typical monorepo layout with multiple packages.

```text
├ lib1
| ├ pyproject.toml
| ├ ....
├ lib2
| ├ pyproject.toml
| ├ ....
```

--------------------------------

### Run Nox Lint Session

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Run linters (mypy and ruff check) across all supported Python versions using Nox.

```bash
nox -s lint

```

--------------------------------

### Add FawltyDeps as a dev dependency with poetry

Source: https://tweag.github.io/FawltyDeps/installation

Add FawltyDeps as a development dependency using Poetry.

```bash
poetry add --group=dev fawltydeps
```

--------------------------------

### Add FawltyDeps as a dev dependency with pdm

Source: https://tweag.github.io/FawltyDeps/installation

Add FawltyDeps as a development dependency using PDM.

```bash
pdm add -dG dev fawltydeps
```

--------------------------------

### Run Nox Integration Tests Session

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Execute the integration tests for a specific Python version (e.g., 3.11) using Nox.

```bash
nox -s integration_tests-3.11

```

--------------------------------

### Run Nox Tests Session

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Execute the 'tests' Nox session, which runs unit tests on supported Python versions.

```bash
nox -s tests

```

--------------------------------

### Run Ruff Linter Directly

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Execute the ruff linter on the current directory. This command assumes the development environment is activated.

```bash
ruff check .

```

--------------------------------

### Run Integration Tests Directly

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Execute integration tests using pytest with the 'integration' marker. This command assumes the development environment is activated.

```bash
pytest -m integration

```

--------------------------------

### Run FawltyDeps on a specific package

Source: https://tweag.github.io/FawltyDeps/how_to_guides

Analyze a specific directory within a monorepo.

```bash
fawltydeps libX
```

--------------------------------

### Fix Formatting with Nox

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Automatically fix code formatting using ruff format via the 'reformat' Nox session.

```bash
nox -s reformat

```

--------------------------------

### Run Nox Tests Session for Specific Python Version

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Run unit tests using a specific Python version (e.g., 3.9) via Nox, if available locally.

```bash
nox -s tests-3.9

```

--------------------------------

### Load exclude patterns from a file

Source: https://tweag.github.io/FawltyDeps/usage

Specify a file containing path patterns to exclude using the --exclude-from option.

```bash
fawltydeps --exclude-from my_excludes.txt
```

--------------------------------

### Prioritize explicit paths over exclusions

Source: https://tweag.github.io/FawltyDeps/usage

Explicitly provided paths via --code override exclusion patterns during directory traversal.

```bash
fawltydeps --code my_file.py --exclude my_file.py
```

```bash
fawltydeps --code my_dir --exclude "*.ipynb"
```

--------------------------------

### Run Unit Tests Directly

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Execute unit tests directly using pytest. This command assumes the development environment is activated.

```bash
pytest

```

--------------------------------

### Configure FawltyDeps in pyproject.toml

Source: https://tweag.github.io/FawltyDeps/configuration

Use the `[tool.fawltydeps]` section in `pyproject.toml` to set default behavior for code analysis, dependency checking, and reporting.

```toml
[tool.fawltydeps]
code = ["myproject"]  # Only search for imports under ./myproject
deps = ["pyproject.toml"]  # Only look for declared dependencies here
ignore_unused = ["black"]  # We use `black`, but we don't intend to import it
output_format = "human_detailed"  # Detailed report by default

```

--------------------------------

### Analyze code from standard input

Source: https://tweag.github.io/FawltyDeps/how_to_guides

Pipe or redirect Python code into FawltyDeps for analysis.

```bash
cat some/source/of/python/code | fawltydeps --code -
# or
fawltydeps --code - < some/source/of/python/code
```

--------------------------------

### Specify search path for FawltyDeps

Source: https://tweag.github.io/FawltyDeps/usage

Analyzes a specific project directory for both code and dependency declarations.

```bash
fawltydeps my_project/
```

--------------------------------

### Clone FawltyDeps Repository

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Clone your fork of the FawltyDeps repository to your local machine.

```bash
git clone git@github.com:<your_username>/FawltyDeps.git

```

--------------------------------

### Define a custom mapping in pyproject.toml

Source: https://tweag.github.io/FawltyDeps/explanation

Embed the custom mapping directly into your project's pyproject.toml file under the [tool.fawltydeps.custom_mapping] section.

```toml
[tool.fawltydeps.custom_mapping]
langchain-core = ["langchain_core"]
multiple-modules = ["module1", "module2"]
my-package = ["mpkg"]
python-dotenv = ["dotenv"]
scikit-learn = ["sklearn"]
```

--------------------------------

### Manually add FawltyDeps to dev-requirements.txt

Source: https://tweag.github.io/FawltyDeps/installation

Manually add FawltyDeps to your development requirements file.

```text
fawltydeps
```

--------------------------------

### Specify base directory for FawltyDeps

Source: https://tweag.github.io/FawltyDeps/FAQ

Use `--base-dir` to explicitly set the directory FawltyDeps should use to find 1st-party imports when default detection is insufficient. This is useful for complex project structures or when analyzing files outside the current directory.

```bash
fawltydeps my_project/
```

```bash
fawltydeps --code=my_project/
```

```bash
fawltydeps --code=projectA/ --code=projectB/
```

```bash
fawltydeps foo/main.py lib/bar.py
```

```bash
fawltydeps foo/main.py lib/bar.py --base-dir=lib/
```

```bash
fawltydeps subproject/main/ subproject/lib/ --base-dir=subproject/
```

```bash
fawltydeps --code=my_project/ --code=other_file.py --base-dir=lib/
```

--------------------------------

### Specify Python Environment for FawltyDeps

Source: https://tweag.github.io/FawltyDeps/explanation

Use the `--pyenv` option to direct FawltyDeps to a specific Python environment for resolving dependencies. This is useful when your project's virtual environment is not automatically discoverable.

```bash
fawltydeps --code my_package/ --deps pyproject.toml --pyenv /path/to/project/venv
```

--------------------------------

### Run Static Type Checking Directly

Source: https://tweag.github.io/FawltyDeps/CONTRIBUTING

Perform static type checking using mypy. This command assumes the development environment is activated.

```bash
mypy

```

--------------------------------

### Analyze clipboard code via stdin

Source: https://tweag.github.io/FawltyDeps/how_to_guides

Use the terminal to paste code directly into FawltyDeps for analysis.

```bash
fawltydeps --code -
# FawltyDeps waits for code on stdin; paste from your clipboard,
# then press Ctrl+D to signal EOF (end-of-file).
```

--------------------------------

### Exclude paths from analysis

Source: https://tweag.github.io/FawltyDeps/usage

Use the --exclude option to skip specific directories or files during dependency analysis.

```bash
fawltydeps --exclude tests/
```

```bash
fawltydeps --exclude tests/ ".*"
```

--------------------------------

### Ignore specific unused dependencies

Source: https://tweag.github.io/FawltyDeps/how_to_guides

Exclude development tools like linters or formatters from the unused dependency report.

```bash
fawltydeps --ignore-unused black pylint
```

--------------------------------

### Test Naming Convention

Source: https://tweag.github.io/FawltyDeps/CodeDesign

Standard naming pattern used for unit and integration tests to describe the function, scenario, and expected outcome.

```text
test_{tested_function}__{short_description}__{expected_result}
```
Tokens:
Raw