The one pip config you need to have
===================================

Whenever you are installing python packages, you should always use a virtual environment. pip makes this easy to follow by adding some configuration to pip.

Date: June 1, 2022

Whenever you are installing python packages, you should always use a virtual
environment. pip makes this easy to follow by adding some configuration to
pip.

## require-virtualenv

Pip is the pacakage tool for python. It installs third-party packages and is
configurable. One of the configuration settings that I highly reccommend
everyone to add is `require-virtualenv`. This will stop pip from installing
any packages if you have not activated a virtualenv.

## why

python packages often require many different dependencies, sometimes packages
are up to date and sometimes they require different versions of dependencies.
If you install everything in one environment its easy to end up with version
conflict issues that are really hard to resolve, especially since your system
environment cannot easily be restarted.

## PIPX my one exception

My one exception that I put in my system level packages is `pipx`. `pipx` is
very handy as it manages virtual environments for you and is intended for
command line utilities that would end up in your system env or require you to
manually manage virtual environments without it.

## pip config

Your pip config might be found in either `~/.pip/pip.conf` or
`~/.config/pip/pip.conf`. You can either use the `pip config set` command or
edit one of these files manually.

```bash
pip config set global.require-virtualenv True
```

Now you sould see this in your `~/.config/pip/pip.conf`

``` toml
[global]
require-virtualenv = True
```

## pip config debug

If you want to know where pip is looking for configuration on your system, and
what files are setting a certain config you can use `pip config debug` to find
it.

``` bash
❯ pip config debug

env_var:
env:
global:
 /etc/xdg/xdg-awesome/pip/pip.conf, exists: False
 /etc/xdg/pip/pip.conf, exists: False
 /etc/pip.conf, exists: False
site:
 /home/waylon/git/waylonwalker.com/.venv/pip.conf, exists: False
user:
 /home/waylon/.pip/pip.conf, exists: False
 /home/waylon/.config/pip/pip.conf, exists: True
 global.require-virtualenv: True
```

## saved my bacon

This setting recently saved me when I modified my `.envrc` file my virtual
environment deactivated, so when I went to pip install something it gave me an
error that it was not active. Situations like this are an easy way to pollute
your system with packages that it does not need installed.

![pip-require-virtualenv-direnv-error.webp](https://dropper.waylonwalker.com/api/file/fdb3d2bc-fd70-4b5b-acaa-aedc91c528b0.webp)

## TLDR

Run this at your command line to avoid polluting your system environment by
mistake before running any pip command.

```bash
pip config set global.require-virtualenv True
```