Need to install `hatch-pip-compile` in system python installation

[ssiccha]

Hi @juftin. I have set up my project as recommended in the hatch-pip-compile docs:

Declare hatch-pip-compile as a dependency in your pyproject.toml file under the [tool.hatch.env] table and hatch will automatically install it. You must also have your environment type set to pip-compile (see Configuration).

However, I can't run hatch run hatch-pip-compile --update --all. I get

/bin/sh: hatch-pip-compile: command not found

I have tried pip install hatch-pip-compile into my mise-managed python installation. That resolves the error. However, when I then pip uninstall hatch-pip-compile, then every time I run hatch run hatch-pip-compile --update --all the plugin gets reinstalled into my mise-managed python installation.

Which of the behaviours is intended?

[juftin]

Hey @ssiccha - I think the issue here comes down to multiple ways to use hatch-pip-compile:

As a Hatch Plugin

When hatch-pip-compile is used as a hatch plugin, it is installed into the same environment as hatch (I personally recommend using a tool like pipx or uv tool to install hatch). This is achieved with the following pyproject.toml config:

[tool.hatch.env]
requires = [
    "hatch-pip-compile"
]

As A CLI

When you want to run hatch-pip-compile as a CLI (presumably to update all of your lockfiles with hatch-pip-compile --update --all) - you should install hatch-pip-compile outside of the hatch environment (again, I personally recommend using a tool like pipx or uv tool to install hatch-pip-compile). This also assumes that you will be using hatch-pip-compile as a hatch plugin.

---

Just a note here, when I say "the hatch environment" I'm referring to the Python environment where hatch is installed and not the virtual environments that hatch creates and manages (with commands like hatch run ...)

---

Hopefully this is helpful? I haven't used mise before (but looked it up and am familiar with the concept) - I think the issue here is that Python CLI tools like hatch (and hatch-pip-compile when used as a CLI) usually function best when installed globally into their own virtual environments with tools like pipx / uv tool

[ssiccha]

Hi @juftin, that makes sense. I was assuming installing it as a hatch plugin would also make the CLI available. In hindsight this makes perfect sense. Do you think it'd make sense to add a clarifying comment to the install instructions? Just something along the lines of what you already wrote:

When you want to run hatch-pip-compile as a CLI (presumably to update all of your lockfiles with hatch-pip-compile --update --all) - you should install hatch-pip-compile outside of the hatch environment. For example via pipx or uv tool.