Add pre-commit hook to run arbitrary entry points (#981)

Co-authored-by: chrysle <[email protected]>
Co-authored-by: Jason Lam <[email protected]>

Author: 3 people

.gitignore

@@ -8,6 +8,7 @@ dist
 activate
 __pypackages__
 venv
+.venv
 .DS_Store
 .tox
 __pycache__

.pre-commit-hooks.yaml

@@ -0,0 +1,6 @@
+-   id: pipx
+    name: pipx
+    entry: pipx run
+    require_serial: true
+    language: python
+    minimum_pre_commit_version: '2.9.2'

CHANGELOG.md

@@ -4,6 +4,7 @@
 - Pass `pip_args` to `shared_libs.upgrade()`
 - Fallback to user's log path if the default log path (`$PIPX_HOME/logs`) is not writable to aid with pipx being used for multi-user (e.g. system-wide) installs of applications
 - Fix wrong interpreter usage when injecting local pip-installable dependencies into venvs
+- add pre-commit hook support
 
 ## 1.2.0
 

README.md

@@ -78,6 +78,10 @@ The zipapp can be downloaded from [Github releases](https://github.com/pypa/pipx
 python pipx.pyz ensurepath
 ```
 
+### Use with pre-commit
+
+pipx [has pre-commit support](docs/installation.md#pre-commit).
+
 ### Shell completions
 
 Shell completions are available by following the instructions printed with this command:

docs/installation.md

@@ -38,6 +38,26 @@ The zipapp can be downloaded from [Github releases](https://github.com/pypa/pipx
 python pipx.pyz ensurepath
 ```
 
+<a name="pre-commit"></a>Or use with pre-commit:
+
+Pipx has [pre-commit](https://pre-commit.com/) support. This lets you run applications:
+* That can be run using `pipx run` but don't have native pre-commit support.
+* Using its prebuilt wheel from pypi.org instead of building it from source.
+* Using pipx's `--spec` and `--index-url` flags.
+
+Example configuration for use of the code linter [yapf](https://github.com/google/yapf/). This is to be added to your `.pre-commit-config.yaml`.
+
+```yaml
+- repo: https://github.com/pypa/pipx
+  rev: 1.2.0
+  hooks:
+  - id: pipx
+    alias: yapf
+    name: yapf
+    args: ['yapf', '-i']
+    types: ['python']
+```
+
 ### Installation Options
 
 The default binary location for pipx-installed apps is `~/.local/bin`. This can be overridden with the environment variable `PIPX_BIN_DIR`.