Skip to main content

Poetry plugin for automatically installing pre-commit hook when it is added to a project

Project description

Poetry pre-commit Plugin

PyPI

A Poetry plugin for automatically installing git pre-commit hooks whenever pre-commit is specified as a dependency of the project.

Motivation

Personally I find that running pre-commit install every time I start working on a new repository is very easy to forget - there have been numerous occasions where I'd forget this step, commit some changes only to be surprised later on by failing CI checks 😅 This plugin aims to solve this issue by doing this small step for me automatically behind the scenes.

Installation

The plugin requires Poetry version 1.2.0b1 or above. Since this is still a pre-release version, you have to specify it explicitly when installing:

curl -sSL https://install.python-poetry.org | python3.9 - --version 1.2.0b3

Once a valid version of Poetry is set up, you can install the plugin like so:

poetry self add poetry-pre-commit-plugin

For more in-depth information, please refer to Poetry's docs.

Usage

There's no way to use this plugin explicitly - it will work behind the scenes after you run either poetry install or poetry add. In either of those cases, the plugin will check the following conditions:

  1. Is the project inside a git repository?
  2. Is pre-commit listed as a dependency of the project (or, in the case of poetry add - was it just added)?
  3. Has the pre-commit hook not been activated yet (i.e. the file .git/hooks/pre-commit does not exist)?

If all conditions are met, the plugin will run pre-commit install for you.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

poetry_pre_commit_plugin-0.2.2.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

poetry_pre_commit_plugin-0.2.2-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file poetry_pre_commit_plugin-0.2.2.tar.gz.

File metadata

  • Download URL: poetry_pre_commit_plugin-0.2.2.tar.gz
  • Upload date:
  • Size: 14.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.9.13 Darwin/23.6.0

File hashes

Hashes for poetry_pre_commit_plugin-0.2.2.tar.gz
Algorithm Hash digest
SHA256 a2aef66039681216295eb0025cba599d9997709b701850c1b2991df67b70531c
MD5 57f680e156fdd9335d61e72999a81792
BLAKE2b-256 3c18906f8634eaf2ee82c716d7941535985bdfc1c543ab8a833e2d225039514c

See more details on using hashes here.

File details

Details for the file poetry_pre_commit_plugin-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for poetry_pre_commit_plugin-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 75ec4aad2711eff98678a5e79a7166fac4d245c0ac9a8734ecfd75083cd1bc55
MD5 86f56100a22563777eaa8dab97ae7968
BLAKE2b-256 1b426167b5ec1e14ba648747ae8b9a479a182bd9fe9c0329344ac3d485b3799f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page