Skip to content

Commit

Permalink
squash! Update FAQ to better explain running FD outside of project env
Browse files Browse the repository at this point in the history
The investigations in issue #460 reveal that for now we are likely less
backwards-compatible than we'd like to be. Until that situation is
improved, let's tell users to open an issue if they encounter problems.
This should help us gauge how to prioritize this.
  • Loading branch information
jherland committed Oct 31, 2024
1 parent 850399c commit 5d73463
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -619,8 +619,8 @@ identical to the package name that you depend on.

### My project is using Python version before v3.8, can I still use FawltyDeps?

Yes! Even though FawltyDeps itself runs on Python >=v3.8, we support analyzing
projects that run on any version of Python 3.
Yes! Even though FawltyDeps itself runs on Python >=v3.8, we try to support
analyzing projects that run on any version of Python 3.

As explained in the previous two questions, FawltyDeps itself does not need to
run inside the same Python environment as you project and its dependencies.
Expand All @@ -633,6 +633,15 @@ from inside your project directory. If there is an embedded Python environment
your project dependencies installed within. Or you can always used `--pyenv` to
point FawltyDeps to where your dependencies are installed.

Currently the lowest Python version that your project can use (and still be
analyzed by FawltyDeps) is determined by our use of the
[`ast` module](https://docs.python.org/3/library/ast.html#module-ast) in the
Python standard library: As long as your project's Python syntax is compatible
with the Python version that FawltyDeps runs on, you should be fine. If you run
into problems with older Python syntax (e.g. using `async` or `await` as
variable names), please open an issue, and we'll look into extending our support
further.

### Why does FawltyDeps fail to match `sklearn` with `scikit-learn`?

There are cases, where FawltyDeps may not match imports and obviously related
Expand Down

0 comments on commit 5d73463

Please sign in to comment.