Skip to main content

A pre commit hook used to maintain license and copyright information in source files.

Project description

nssacPreCommitHook

Install

Linux and MacOS X

  • System wide installation
sudo pip install nssacPreCommitHook
  • User local installation
pip install nssacPreCommitHook --user

Windows

 pip install nssacPreCommitHook
  • User local installation (not recommeded as the script path is not in the search PATH)
pip install nssacPreCommitHook --user

Configuration

The configuration uses a JSON schema to specify the license and the copyright statements to be used.

Two examples are provided:

Enable nssacPreCommitHook for a repository

Download Example and save it.

preCommitHook.py --init -r repository -c Path_to_Example

If you saved the example as repository/.nssac.json you may ommit -c Path_to_Example

Suported file formats:

The patterns section of the example currently supports the following formats

  • C/C++ ".cpp", ".hpp", ".c", ".h", "*.h.in"
  • Java "*.java"
  • XML ".xsd", ".xml", "*.rng"
  • Shell "*.sh"
  • CMake "*.cmake", "CMakeLists.txt"
  • Python "*.py"

It is not difficult to add more file types often is is just adding another pattern to the include section of an exiting pattern.

Project details


Release history Release notifications

Download files

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

Files for nssacPreCommitHook, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size nssacPreCommitHook-1.0.1-py3-none-any.whl (14.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size nssacPreCommitHook-1.0.1.tar.gz (8.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page