You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2013/10/26 12:46:22 UTC
[1/3] git commit: Add git pre-commit hook script for running flake8
on modified Python files.
Updated Branches:
refs/heads/trunk b8b3ca33a -> 6fa1d95fa
Add git pre-commit hook script for running flake8 on modified Python files.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/367c1f9e
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/367c1f9e
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/367c1f9e
Branch: refs/heads/trunk
Commit: 367c1f9e236c66fa5b8045d3348dd6ac04113ffe
Parents: b8b3ca3
Author: Tomaz Muraus <to...@apache.org>
Authored: Sat Oct 26 12:39:16 2013 +0200
Committer: Tomaz Muraus <to...@apache.org>
Committed: Sat Oct 26 12:39:16 2013 +0200
----------------------------------------------------------------------
contrib/pre-commit.sh | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/367c1f9e/contrib/pre-commit.sh
----------------------------------------------------------------------
diff --git a/contrib/pre-commit.sh b/contrib/pre-commit.sh
new file mode 100755
index 0000000..5fdba09
--- /dev/null
+++ b/contrib/pre-commit.sh
@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+
+files=$(git diff --cached --name-status | grep -v ^D | awk '$1 $2 { print $2}' | grep -e .py$)
+array=(${files/// })
+
+for file in "${array[@]}"
+do
+ if [[ ${file} =~ "libcloud/test/" ]]; then
+ flake8 --max-line-length=160 ${file}
+ continue
+ else
+ flake8 ${file}
+ fi
+done
[3/3] git commit: Remove unnecessary contribute.
Posted by to...@apache.org.
Remove unnecessary contribute.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/6fa1d95f
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/6fa1d95f
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/6fa1d95f
Branch: refs/heads/trunk
Commit: 6fa1d95fa3f711878eb3a19e2c5ceda4c14cb890
Parents: 9f02b0c
Author: Tomaz Muraus <to...@apache.org>
Authored: Sat Oct 26 12:45:45 2013 +0200
Committer: Tomaz Muraus <to...@apache.org>
Committed: Sat Oct 26 12:45:45 2013 +0200
----------------------------------------------------------------------
contrib/pre-commit.sh | 1 -
1 file changed, 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6fa1d95f/contrib/pre-commit.sh
----------------------------------------------------------------------
diff --git a/contrib/pre-commit.sh b/contrib/pre-commit.sh
index 5fdba09..2a65aac 100755
--- a/contrib/pre-commit.sh
+++ b/contrib/pre-commit.sh
@@ -23,7 +23,6 @@ for file in "${array[@]}"
do
if [[ ${file} =~ "libcloud/test/" ]]; then
flake8 --max-line-length=160 ${file}
- continue
else
flake8 ${file}
fi
[2/3] git commit: docs: Document how to install a pre-commit hook.
Posted by to...@apache.org.
docs: Document how to install a pre-commit hook.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/9f02b0cc
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/9f02b0cc
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/9f02b0cc
Branch: refs/heads/trunk
Commit: 9f02b0cc8a63f76dca94c48f6f867781bc3e8cf1
Parents: 367c1f9
Author: Tomaz Muraus <to...@apache.org>
Authored: Sat Oct 26 12:44:32 2013 +0200
Committer: Tomaz Muraus <to...@apache.org>
Committed: Sat Oct 26 12:44:32 2013 +0200
----------------------------------------------------------------------
docs/development.rst | 24 ++++++++++++++++++++++--
1 file changed, 22 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/9f02b0cc/docs/development.rst
----------------------------------------------------------------------
diff --git a/docs/development.rst b/docs/development.rst
index 224180e..d5c1413 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -11,14 +11,34 @@ This page explains how you can contribute to the Libcloud project. If you get
stuck at any point during this process, stop by on our IRC channel (#libcloud
on freenode) and we will do our best to assist you.
-Style Guide
+Style guide
-----------
* We follow `PEP8 Python Style Guide`_
* Use 4 spaces for a tab
+* Use 79 characters in a line
* Make sure edited file doesn't contain any trailing whitespace
* You can verify that your modifications don't break any rules by running the
- ``pep8 script - e.g. pep8 libcloud/edited_file.py.``
+ ``flake8 script - e.g. flake8 libcloud/edited_file.py.`` or ``tox -e lint``.
+ Second command fill run flake8 on all the files in the repository.
+
+Git pre-commit hook
+-------------------
+
+To make complying with our style guide easier, we provide a git pre-commit hook
+which automatically checks modified Python files for violations of our style
+guide.
+
+You can install it by running following command in the root of the repository
+checkout:
+
+.. sourcecode:: bash
+
+ ln -s contrib/pre-commit.sh .git/hooks/pre-commit
+
+After you have installed this hook it will automatically check modified Python
+files for violations before a commit. If a violation is found, commit will be
+aborted.
General guidelines
------------------