Skip to content

Commit

Permalink
improve note on pip install path
Browse files Browse the repository at this point in the history
closes #14
  • Loading branch information
lreiher committed Jun 10, 2023
1 parent c35d158 commit cea6b6d
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,13 @@ pip install docker-run-cli
source $(activate-python-docker-run-shell-completion 2> /dev/null)
```

> Note:
> *pip* installs scripts into `~/.local/bin` and this is not on the default *Debian/Ubuntu* `$PATH`. To run `docker-run`, please make sure its in your `$PATH`. E.g. by running `$PATH=$PATH:~/.local/bin`.
> **Warning**
> Outside of a virtual environment, *pip* may default to a user-site installation of executables to `~/.local/bin`, which may not be present in your shell's `PATH`. If running `docker-run` errors with `docker-run: command not found`, add the directory to your path. [*(More information)*](https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-to-the-user-site)
> ```bash
> echo "export PATH=$HOME/.local/bin:$PATH" >> ~/.bashrc
> source ~/.bashrc
> ```
## Usage
Expand Down

0 comments on commit cea6b6d

Please sign in to comment.