Eliminate global state, reducing technical debt

.gitignore

@@ -10,3 +10,4 @@ htmlcov/
 .idea
 *.mo
 *.pot
+.tox

Pipfile

@@ -7,7 +7,7 @@ name = "pypi"
 
 [packages]
 
-gitpython = "*"
+GitPython = "*"
 stdlib-list = "*"
 mccabe = "*"
 "pep8" = "*"
@@ -18,5 +18,5 @@ mccabe = "*"
 pytest = "*"
 pytest-cov = "*"
 codecov = "*"
-babel = "*"
+Babel = "*"
 tox = "*"

README.rst

@@ -0,0 +1,114 @@
+Fiasko Bro
+==========
+
+   When flake8 is not enough.
+
+.. image:: https://travis-ci.org/devmanorg/fiasko_bro.svg?branch=master
+   :target: https://travis-ci.org/devmanorg/fiasko_bro
+   :alt: Build Status
+
+.. image:: https://codecov.io/gh/devmanorg/fiasko_bro/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/devmanorg/fiasko_bro
+   :alt: codecov
+
+.. image:: https://readthedocs.org/projects/fiasko-bro/badge/?version=latest
+   :target: http://fiasko-bro.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+
+.. image:: https://api.codeclimate.com/v1/badges/4f26aec50f07294b37e3/maintainability
+   :target: https://codeclimate.com/github/devmanorg/fiasko_bro/maintainability
+   :alt: Maintainability
+
+.. image:: https://badge.fury.io/py/Fiasko-Bro.svg
+   :target: https://badge.fury.io/py/Fiasko-Bro
+   :alt: PyPI version
+
+Fiasko is a static analysis tool for Python code that catches common style errors.
+
+.. image:: http://melevir.com/static/fiasko.jpg
+
+Example
+~~~~~~~
+
+From command line:
+
+.. code-block:: bash
+
+    $ fiasko -p ~/projects/fiasko_bro
+    git_history_warning                     	add files via upload
+    pep8                                    	33 PEP8 violations
+    mccabe_failure                          	has_changed_readme
+    has_star_import                         	__init__.py
+    has_local_import                        	setup.py
+    bad_titles                              	name, n
+    bad_titles                              	i, r, n, t, l
+    file_too_long                           	ast_helpers.py
+    too_nested                              	code_validator.py:54
+    indent_not_four_spaces                  	ast_helpers.py:130
+    title_shadows                           	slice
+    ==================================================
+    Total 11 violations
+
+See ``fiasko --help`` for more CLI arguments.
+
+From Python code:
+
+.. code-block:: python
+
+    >>> from fiasko_bro import validate
+    >>> validate('/user/projects/fiasko_bro/')
+    [('git_history_warning', 'add files via upload'), ('pep8', '33 PEP8 violations'), ('mccabe_failure', 'has_changed_readme'), ('has_star_import', '__init__.py'), ('has_local_import', 'setup.py'), ('bad_titles', 'name, n'), ('bad_titles', 'n, r, l, t, i'), ('file_too_long', 'ast_helpers.py'), ('too_nested', 'code_validator.py:54'), ('indent_not_four_spaces', 'ast_helpers.py:130'), ('title_shadows', '_, slice')]
+
+The ``validate`` method returns list of tuples which consist of an error slug and an error message.
+
+Fiasko has a flexible Python API which you can read more about `in the docs <https://fiasko-bro.readthedocs.io/en/latest/advanced_usage.html>`_.
+
+Installation
+~~~~~~~~~~~~
+
+With pip:
+
+.. code-block:: bash
+
+    pip install fiasko_bro
+
+With Pipenv:
+
+.. code-block:: bash
+
+    pipenv install fiasko_bro
+
+Or just clone the project and install the requirements:
+
+.. code-block:: bash
+
+    $ git clone https://github.com/devmanorg/fiasko_bro.git
+    $ cd fiasko_bro
+    $ pip install -r requirements.txt
+
+Docs
+~~~~
+
+`fiasko-bro.readthedocs.io <http://fiasko-bro.readthedocs.io/>`_
+
+
+Contributing
+~~~~~~~~~~~~
+
+To contribute, `pick an issue <https://github.com/devmanorg/fiasko_bro/issues>`_ to work on and leave a comment saying
+that you've taken the issue. Don't forget to mention when you want to submit the pull request.
+
+You can read more about contribution guidelines in `the docs <http://fiasko-bro.readthedocs.io/en/latest/contributing.html>`_
+
+If your suggestion (or bug report) is new, be sure to `create an issue <https://github.com/devmanorg/fiasko_bro/issues/>`_ first.
+
+Launch tests
+~~~~~~~~~~~~
+
+``python -m pytest``
+
+
+Versioning
+~~~~~~~~~~
+
+We follow `semantic versioning <https://github.com/dbrock/semver-howto/blob/master/README.md)>`_.

bin/fiasko.py

@@ -1,7 +1,7 @@
 import os
 import argparse
 
-import fiasko_bro
+from fiasko_bro import validate
 from fiasko_bro.configparser_helpers import extract_fiasko_config_from_cfg_file
 
 
@@ -16,8 +16,7 @@ def main():
     args = parse_args()
     config_path = args.config_path or os.path.join(args.path, 'setup.cfg')
     updated_config = extract_fiasko_config_from_cfg_file(config_path)
-    fiasko_bro.config.VALIDATOR_SETTINGS.update(updated_config)
-    violations = fiasko_bro.validate_repo(args.path)
+    violations = validate(args.path, **updated_config)
     for violation_slug, violation_message in violations:
         print('%-40s\t%s' % (violation_slug, violation_message))
     print('=' * 50)