Skip to main content

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.

Metadata

Release files for commitguard 2.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for commitguard 2.2.0
File Size Uploaded
commitguard-2.2.0.tar.gz 49.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for commitguard 2.2.0
File Interpreter ABI Platform
commitguard-2.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 76.3 kB

Release files / commitguard-2.2.0.tar.gz

Download URL commitguard-2.2.0.tar.gz
Size 49.0 kB
Tags Source
SHA-256 checksum
How to use checksums
0050ba4d9341be3e5f073df2bd27ad4367325af29b49e01f2c76bf3bcbc5ae8a
BLAKE2b-256 checksum
How to use checksums
9adf5354733bc42ad61048c785038dd9419ed566a1c023f2909cd58111cf50ec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.2 CPython/3.10.11 Linux/5.15.0-1037-azure

Release files / commitguard-2.2.0-py3-none-any.whl

Download URL commitguard-2.2.0-py3-none-any.whl
Size 27.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
304d9353e443bd0bc016463034ab488aca93dde09da53fef41f4d654e552abaf
BLAKE2b-256 checksum
How to use checksums
044d2467e7d3c00b05f5d314afdd1891c3743e98f106c3894e4734b4dc4cbebb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.2 CPython/3.10.11 Linux/5.15.0-1037-azure

Release history Release notifications | RSS feed

This release

2.2.0 This release

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page