Turnstile - Local Git Hooks

Configurable local git hooks.

Installation

You can install turnstile using pip:

$ pip install turnstile-core

Alternatively, you can install it using setup.py:

$ setup.py install

Adding and removing turnstile from a repository

To use turnstile in a repository, run turnstile install inside the repository.

To remove turnstile from a repository, run turnstile remove inside the repository.

Configuring turnstile

You can configure the global hook behaviour by running turnstile config.

Currently you can only configure the hook verbosity.

Repository configuration

To use turnstile, you need to add a configuration file named .turnstile.yml to your repository.

You can find an example configuration in turnstile repository and can learn more about the configuration options in the documentation.

Adding subcommands

Turnstile looks for command extensions in turnstile.commands entry points.

To make a new subcommand, create a click command named cmd and add the module with command to your setup.py entry points in the 'turnstile.commands' group.

More information

To learn more, check turnstile's documentation.

License

Copyright 2015 Zalando SE

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.