Merge pull request #141 from maennel/django19_up_pep8

PEP8 for CleanerVersion compatible with Django 1.9 and up.

.travis.yml

@@ -10,6 +10,7 @@ env:
   - TOX_ENV=django110-sqlite
   - TOX_ENV=django111-pg
   - TOX_ENV=django111-sqlite
+  - TOX_ENV=pep8
 
 
 # Enable PostgreSQL usage

cleanerversion/__init__.py

@@ -1,5 +1,6 @@
 VERSION = (2, 0, 0)
 
+
 def get_version(positions=None):
     version = VERSION
     if positions and isinstance(positions, int):

cleanerversion/settings/base.py

@@ -28,8 +28,9 @@
         'DIRS': [],
         'APP_DIRS': True,
         'OPTIONS': {
-            'context_processors': ['django.contrib.auth.context_processors.auth',
-                                   'django.contrib.messages.context_processors.messages'],
+            'context_processors': [
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages'],
         },
     },
 ]

docs/conf.py

@@ -12,21 +12,21 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
 import os
+import sys
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('.'))
 import cleanerversion
 
 sys.path.insert(len(sys.path), os.path.abspath('..'))
 
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -46,7 +46,7 @@
 source_suffix = '.rst'
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
@@ -71,37 +71,37 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 
 # -- Options for HTML output ----------------------------------------------
@@ -113,123 +113,122 @@
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-#html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'CleanerVersionDoc'
 
-
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'CleanerVersion.tex', u'CleanerVersion Documentation',
-   u'Jean-Christophe Zulian, Brian King, Andrea Marcacci, Manuel Jeckelmann',
-   'manual'),
+    ('index', 'CleanerVersion.tex', u'CleanerVersion Documentation',
+     u'Jean-Christophe Zulian, Brian King, Andrea Marcacci, Manuel Jeckelmann',
+     'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output ---------------------------------------
@@ -246,7 +245,7 @@
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -255,26 +254,26 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index',
-   'CleanerVersion',
-   u'CleanerVersion Documentation',
-   u'Jean-Christophe Zulian, Brian King, Andrea Marcacci, Manuel Jeckelmann',
-   'CleanerVersion',
-   'One line description of project.',
-   'Miscellaneous'),
+    ('index',
+     'CleanerVersion',
+     u'CleanerVersion Documentation',
+     u'Jean-Christophe Zulian, Brian King, Andrea Marcacci, Manuel Jeckelmann',
+     'CleanerVersion',
+     'One line description of project.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False
 
 
 # Example configuration for intersphinx: refer to the Python standard library.

manage.py

@@ -3,7 +3,8 @@
 import sys
 
 if __name__ == "__main__":
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", 'cleanerversion.settings.base')
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE",
+                          'cleanerversion.settings.base')
 
     from django.core.management import execute_from_command_line
 

setup.py

@@ -2,25 +2,25 @@
 from setuptools import setup, find_packages
 
 """
-Documentation can be found at https://docs.python.org/2/distutils/index.html, 
-but usually you only need to do the following steps to publish a new package 
+Documentation can be found at https://docs.python.org/2/distutils/index.html,
+but usually you only need to do the following steps to publish a new package
 version to PyPI::
 
     # Update the version tag in this file (setup.py)
-    python setup.py sdist --formats=gztar,zip 
+    python setup.py sdist --formats=gztar,zip
     twine upload dist/*
 
-That's already it. You should get the following output written to your 
+That's already it. You should get the following output written to your
 command line::
 
     Server response (200): OK
 
 If you get errors, check the following things:
 
-- Are you behind a proxy? --> Try not to be behind a proxy (I don't actually 
+- Are you behind a proxy? --> Try not to be behind a proxy (I don't actually
     know how to configure setup.py to be proxy-aware)
 - Is your command correct? --> Double-check using the reference documentation
-- Do you have all the necessary libraries to generate the wanted formats? --> 
+- Do you have all the necessary libraries to generate the wanted formats? -->
     Reduce the set of formats or install libs
 """
 

tox.ini

@@ -6,14 +6,17 @@
 [tox]
 envlist =
 	django{19,110,111}-{sqlite,pg}
+	pep8
 
 [testenv]
 deps =
 	coverage
+	pep8: pep8
 	django19: django>=1.9,<1.10
 	django110: django>=1.10,<1.11
 	django111: django>=1.11,<1.12
 	pg: psycopg2
 commands =
 	pg: coverage run --source=versions ./manage.py test --settings={env:TOX_PG_CONF:cleanerversion.settings.pg}
 	sqlite: coverage run --source=versions ./manage.py test --settings=cleanerversion.settings.sqlite
+	pep8: pep8