Merge pull request #543 from dekoza/feature/pre-commit

Add pre-commit hooks

Author: jmadler

.gitignore

@@ -41,3 +41,6 @@ nosetests.xml
 .mr.developer.cfg
 .project
 .pydevproject
+
+# PyCharm
+.idea

.pre-commit-hooks.yaml

@@ -0,0 +1,15 @@
+- id: futurize
+  name: futurize
+  description: Futurize your Py2 code to ensure it is runnable on Py3.
+  language: python
+  types: [python]
+  entry: futurize -w -n --no-diffs
+  args: [--stage1]
+
+- id: pasteurize
+  name: pasteurize
+  description: Pasteurize your Py3 code to ensure it is runnable on Py2.
+  language: python
+  language_version: python3
+  types: [python]
+  entry: pasteurize -w -n --no-diffs

README.rst

@@ -57,6 +57,8 @@ Features
     decoding the backported ``str`` and ``bytes`` objects. [This feature is
     currently in alpha.]
 
+-   support for pre-commit hooks
+
 .. _code-examples:
 
 Code examples
@@ -261,6 +263,39 @@ development, and will likely never be perfect.
 
 For more info, see :ref:`translation`.
 
+Pre-commit hooks
+----------------
+
+`Pre-commit <https://pre-commit.com/>`_ is a framework for managing and maintaining
+multi-language pre-commit hooks.
+
+In case you need to port your project from Python 2 to Python 3, you might consider
+using such hook during the transition period.
+
+First:
+
+.. code-block:: bash
+
+    $ pip install pre-commit
+
+and then in your project's directory:
+
+.. code-block:: bash
+
+    $ pre-commit install
+
+Next, you need to add this entry to your ``.pre-commit-config.yaml``
+
+.. code-block:: yaml
+
+    -   repo: https://github.com/PythonCharmers/python-future
+        rev: master
+        hooks:
+            - id: futurize
+              args: [--both-stages]
+
+The ``args`` part is optional, by default only stage1 is applied.
+
 Licensing
 ---------