Merge pull request #102 from SanketDG/coala!

Add .coafile

.coafile

@@ -0,0 +1,38 @@
+[Default]
+files = pydsa/**/*.py
+
+max_line_length = 80
+use_spaces = True
+no_orig = yeah
+
+[python]
+# Patches may conflict with autopep8 so putting them in own section so they
+# will be executed sequentially; also we need the LineLengthBear to double
+# check the line length because PEP8Bear sometimes isn't able to correct the
+# linelength.
+bears = SpaceConsistencyBear, PyUnusedCodeBear
+default_actions =
+    SpaceConsistencyBear: ApplyPatchAction,
+    PyUnusedCodeBear: ApplyPatchAction
+
+[pylint]
+enabled = False
+bears = PyLintBear
+pylint_disable = missing-docstring,
+                 C0103 # simple variable names
+                 C0411 # sorting imports
+
+
+[autopep8]
+bears = PEP8Bear
+default_actions = PEP8Bear: ApplyPatchAction
+
+[imports]
+enabled = False
+bears = PyImportSortBear
+default_actions = PyImportSortBear: ShowPatchAction
+
+[invalidlinks]
+enabled = False
+files = docs/source/*.rst
+bears = InvalidLinkBear

README.md

@@ -11,6 +11,7 @@ Python Data Structure and Algorithms Library (α-mode)
 1. [Installation](#installation)
 2. [Usage](#usage)
 3. [Development Environment](#development-environment)
+    * [Code Analysis](#code-analysis)
 4. [Contributing](#contributing)
 
 ## Installation
@@ -50,16 +51,37 @@ The source code is managed with the Git version control system. To get the lates
 $ git clone https://github.com/pydsa/pydsa.git
 ```
 
-You should then install the dependency for running the tests:
+You should then install the development requirements:
 
-* [pytest](http://pytest.org/latest/getting-started.html#getstarted)
+```
+pip install -r requirements.txt
+```
 
 To run tests:
 
 ```
 $ py.test
 ```
 
+### Code Analysis
+
+[`coala`](https://github.com/coala-analyzer/coala) is used to lint and format
+code.
+
+To analyze code using `coala`:
+
+```
+$ coala
+```
+
+There also other checks that you can run with coala:
+
+```
+$ coala pylint # checks the whole codebase against pylint.
+$ coala invalidlinks # checks docs for invalid links.
+$ coala imports # sort imports
+```
+
 ## Contributing
 
 There are multiple ways you can contibute to Pydsa

requirements.txt

@@ -0,0 +1,2 @@
+coala-bears==0.2.1
+py.test

setup.py

@@ -8,5 +8,5 @@
       license='BSD',
       packages=['pydsa'],
       zip_safe=False,
-      install_requires=['autopep8'],
+      install_requires=[],
       )