Skip to content

Commit

Permalink
add workaround for debugpy install issue to contrib docs
Browse files Browse the repository at this point in the history
When following the Quick Start instructions in the contributing docs, I was getting a "WheelFileValidationError" on installation of debugpy
which was blocking the installation of a number of other deps. Google turned up this [GitHub issue](microsoft/debugpy#1246)
indicating a regression in Poetry 1.4.1 and workarounds.
  • Loading branch information
mtucker committed Mar 20, 2023
1 parent 0ca1641 commit 41cf603
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ poetry install -E all

This will install all requirements for running the package, examples, linting, formatting, tests, and coverage. Note the `-E all` flag will install all optional dependencies necessary for integration testing.

❗Note: If you're running Poetry 1.4.1 and receive a `WheelFileValidationError` for `debugpy` during installation, you can try either downgrading to Poetry 1.4.0 or disabling "modern installation" (`poetry config installer.modern-installation false`) and re-install requirements. See [this `debugpy` issue](https://github.com/microsoft/debugpy/issues/1246) for more details.

Now, you should be able to run the common tasks in the following section.

## ✅Common Tasks
Expand Down

0 comments on commit 41cf603

Please sign in to comment.