hatch-pip-compile

hatch plugin to use pip-compile to manage project dependencies

Installation

pip install hatch-pip-compile

pipx

If you use pipx to install and use hatch you will need to inject the hatch-pip-compile plugin into the hatch environment.

pipx install hatch
pipx inject hatch hatch-pip-compile

Usage

The hatch-pip-compile plugin will automatically run pip-compile whenever your environment needs to be updated. Behind the scenes, this plugin creates a lockfile at requirements.txt (non-default lockfiles are located at .hatch/<envName>.lock). Alongside pip-compile, this plugin also uses pip-sync to install the dependencies from the lockfile into your environment.

Configuration

The environment plugin name is pip-compile.

• pyproject.toml

  [tool.hatch.envs.default]
  type = "pip-compile"
  

• hatch.toml

  [envs.default]
  type = "pip-compile"
  

Configuration Options

Examples

lock-directory

The directory where the lockfiles will be stored. Defaults to the project root for the default environment, and .hatch for non-default environments.

• pyproject.toml

  [tool.hatch.envs.<envName>]
  type = "pip-compile"
  lock-directory = "requirements"
  

• hatch.toml

  [envs.<envName>]
  type = "pip-compile"
  lock-directory = "requirements"
  

lock-filename

The filename of the ultimate lockfile. Defaults to requirements.txt for the default environment, and <envName>.lock for non-default environments.

• pyproject.toml

  [tool.hatch.envs.lint]
  type = "pip-compile"
  lock-directory = "."
  lock-filename = "linting-lockfile.txt"
  

• hatch.toml

  [envs.lint]
  type = "pip-compile"
  lock-directory = "."
  lock-filename = "linting-lockfile.txt"
  

pip-compile-hashes

Whether to generate hashes in the lockfile. Defaults to true.

• pyproject.toml

  [tool.hatch.envs.<envName>]
  type = "pip-compile"
  pip-compile-hashes = true
  

• hatch.toml

  [envs.<envName>]
  type = "pip-compile"
  pip-compile-hashes = true
  

pip-compile-args

Extra arguments to pass to pip-compile. Custom PyPI indexes can be specified here.

• pyproject.toml

  [tool.hatch.envs.<envName>]
  type = "pip-compile"
  pip-compile-args = [
      "--index-url",
      "https://pypi.org/simple",
  ]
  

• hatch.toml

  [envs.<envName>]
  type = "pip-compile"
  pip-compile-args = [
      "--index-url",
      "https://pypi.org/simple",
  ]
  

Notes

Dev Dependencies

Using the default hatch configuration, dev dependencies listed in your default environment (like pytest) will be included on the default lockfile (requirements.txt). If you want to remove your dev dependencies from the lockfile you must remove them from the default environment on your pyproject.toml / hatch.toml file.

Check Out the Docs

Looking to contribute? See the Contributing Guide

See the Changelog