Metadata-Version: 2.1
Name: nssacPreCommitHook
Version: 1.0.1
Summary: A pre commit hook used to maintain license and copyright information in source files.
Home-page: http://github.com/NSSAC/nssacPreCommitHook
Author: Stefan Hoops
Author-email: shoops@virginia.edu
License: Apache 2.0
Description: # nssacPreCommitHook
        
        ## Install
        
        ### Linux and MacOS X
        * System wide installation
        ``` sh
        sudo pip install nssacPreCommitHook
        ```
        
        * User local installation
        ``` sh
        pip install nssacPreCommitHook --user
        ```
        
        ### Windows
        * System installation [(Instructions on how to run a console as administrator)](https://www.howtogeek.com/194041/how-to-open-the-command-prompt-as-administrator-in-windows-8.1/)
        ``` sh
         pip install nssacPreCommitHook
        ```
        
        * User local installation (not recommeded as the script path is not in the search PATH)
        ``` sh
        pip install nssacPreCommitHook --user
        ```
        
        ## Configuration
        The configuration uses a [JSON schema](https://github.com/NSSAC/nssacPreCommitHook/blob/master/schema/preCommitHook.json) to specify the license and the copyright statements to be used.
        
        Two examples are provided:
          * [Example 1](https://github.com/NSSAC/nssacPreCommitHook/blob/master/schema/example.json)
          * [Example 2](https://github.com/NSSAC/nssacPreCommitHook/blob/master/test/example.json)
          
        ## Enable nssacPreCommitHook for a repository
        Download [Example](https://github.com/NSSAC/nssacPreCommitHook/blob/master/schema/example.json) and save it. 
        
        ``` sh
        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.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
