Skip to main content

Library for managing and writing git hooks in Python using pyproject.toml for its settings ✨

Project description

Library for managing and writing git hooks in Python using `pyproject.toml` for its settings ✨

Installation

You can add commitguard in a few easy steps. First of all, install the dependency:

$ pip install commitguard

---> 100%

Successfully installed commitguard-0.1.0

or Using poetry

poetry add --dev commitguard
poetry run commitguard activate --mode poetry

The output of commitguard activate should be similar to:

  commitguard pre-commit hook installed at /commitguard/.git/hooks/pre-commit using poetry mode.

CommitGuard offers an adaptable plugin architecture where each plugin offers unique features that might require the installation of supplementary dependencies.

To manage these dependencies, CommitGuard presently supports three modes:

  • pythonpath for dependency management via [pip]
  • poetry for dependency management via [poetry] (recommended)
  • pipenv for dependency management via [pipenv]

These modes dictate how CommitGuard, the plugins, and their dependencies are loaded during git hook execution.

License

This project is licensed under the terms of the MIT license.

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

commitguard-2.2.0.tar.gz (49.0 kB view hashes)

Uploaded Source

Built Distribution

commitguard-2.2.0-py3-none-any.whl (27.3 kB view hashes)

Uploaded Python 3

Supported by

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