Skip to content

Commit

Permalink
Update README.md (#18)
Browse files Browse the repository at this point in the history
Add a mention about symlinks in the venv, and instructions for `venv`.
  • Loading branch information
GuillaumeDesforges authored Sep 4, 2024
1 parent 0e46f14 commit 2926402
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ nix profile install github:GuillaumeDesforges/fix-python

In your Python project, create a virtual environment `.venv` and use your preferred tool (pip, poetry, ...) to install your dependencies.

> [!IMPORTANT]
> `fix-python` will patch binary files in the virtual environment _without_ following symlinks.
>
> For example, if you use the `venv` module from Python's standard library, please make sure you pass `--copies` when creating the environment.
> ```bash
> python -m venv .venv --copies
> ```
By default, `fix-python` patches the packages given in the following expression:
```nix
let pkgs = import (builtins.getFlake "nixpkgs") { };
Expand Down

0 comments on commit 2926402

Please sign in to comment.