hatch plugin to use pip-compile to manage project dependencies
Project description
hatch-pip-compile
hatch plugin to use pip-compile to manage project dependencies
Installation
pip install hatch-pip-compile
pipx
Personally, I use pipx to install and use hatch. If you do too,
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 .hatch/<ENV_NAME>.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.<ENV_NAME>] type = "pip-compile"
-
hatch.toml
[envs.<ENV_NAME>] type = "pip-compile"
lock-directory
The directory where the lockfiles will be stored. Defaults to .hatch
.
-
pyproject.toml
[tool.hatch.envs.<ENV_NAME>] type = "pip-compile" lock-directory = "requirements"
-
hatch.toml
[envs.<ENV_NAME>] type = "pip-compile" lock-directory = "requirements"
pip-compile-hashes
Whether or not to use hashes in the lockfile. Defaults to true
.
-
pyproject.toml
[tool.hatch.envs.<ENV_NAME>] type = "pip-compile" pip-compile-hashes = true
-
hatch.toml
[envs.<ENV_NAME>] type = "pip-compile" pip-compile-hashes = true
pip-compile-args
Extra arguments to pass to pip-compile
. Defaults to None.
-
pyproject.toml
[tool.hatch.envs.<ENV_NAME>] type = "pip-compile" pip-compile-args = [ "--index-url", "https://pypi.org/simple", ]
-
hatch.toml
[envs.<ENV_NAME>] type = "pip-compile" pip-compile-args = [ "--index-url", "https://pypi.org/simple", ]
Check Out the Docs
Looking to contribute? See the Contributing Guide
See the Changelog
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hatch_pip_compile-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9b23625aa62a448d798992ff7a873a07e630604d5ff62073b8ba52d4be11428 |
|
MD5 | 0c6928957aa714ec2a506c47fff856d6 |
|
BLAKE2b-256 | d44f87ec8ac93ad2d525da520ad63b8c47202f2a8753e31e6fe187fea7838fc9 |