MKDocs Plugin Install Error

[annebrown]

Description

This:

pip install mkdocs-some-plugin

Throws this:

error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
    python3-xyz, where xyz is the package you are trying to
    install.

    If you wish to install a non-Debian-packaged Python package,
    create a virtual environment using python3 -m venv path/to/venv.
    Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
    sure you have python3-full installed.

    If you wish to install a non-Debian packaged Python application,
    it may be easiest to use pipx install xyz, which will manage a
    virtual environment for you. Make sure you have pipx installed.

    See /usr/share/doc/python3.12/README.venv for more information.

note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.

Solution

Some Python-based projects require a virtual env.

When a venv is activated for a proj, pip will install all pkgs in [project_dir]/.venv. This isolates the proj with its own specific Python interpreter, and software libs and binaries.

Create venv

Create .venv under proj dir:

cd [proj-dir]
python3 -m venv .venv

Activate venv

Activate Python virtual env:

source .venv/bin/activate

pip will now install every Python pkg into ./.venv until venv is deactivated (exit or Ctrl-C or close terminal).

A project's venv must be re-activated (source .venv/bin/activate) to install more pkgs or run services.

Add Shortcut to .bash_aliases

alias activate-venv="source ./.venv/bin/activate"

List Installed venv Pkgs

To list installed pkgs while venv is activated:

pip list

Status

SOLVED