Merge pull request #83 from zachlowry/code-cleanup-and-fixes

Code cleanup and fixes

Author: bscSCORM

docs/source/conf.py

@@ -22,17 +22,19 @@
 
 # -- General configuration ------------------------------------------------
 
+
 # Ensure that the __init__ method gets documented.
 def skip(app, what, name, obj, skip, options):
     if name == "__init__":
         return False
     return skip
 
+
 def setup(app):
     app.connect("autodoc-skip-member", skip)
 
 # 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
@@ -48,7 +50,7 @@ def setup(app):
 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'
@@ -68,41 +70,41 @@ def setup(app):
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# #language = None
 
 # 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 = []
 
 # 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 ----------------------------------------------
@@ -114,26 +116,26 @@ def setup(app):
 # 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,
@@ -143,93 +145,92 @@ def setup(app):
 # 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 = 'TinCanPythondoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
 
-latex_elements = {
 # The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+# #'papersize': 'letterpaper',
 
 # The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+# #'pointsize': '10pt',
 
 # Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
+# #'preamble': '',
+latex_elements = {}
 
 # 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', 'TinCanPython.tex', u'Tin Can Python Documentation',
-   u'Rustici Software', 'manual'),
+    ('index', 'TinCanPython.tex', u'Tin Can Python Documentation',
+        u'Rustici Software', '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 ---------------------------------------
@@ -242,7 +243,7 @@ def setup(app):
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# #man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -251,19 +252,19 @@ def setup(app):
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'TinCanPython', u'Tin Can Python Documentation',
-   u'Rustici Software', 'TinCanPython', 'One line description of project.',
-   'Miscellaneous'),
+    ('index', 'TinCanPython', u'Tin Can Python Documentation',
+        u'Rustici Software', 'TinCanPython',
+        '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

examples/example_script.py

@@ -1,6 +1,7 @@
 # An example script showing the functionality of the TinCanPython Library
 
 import uuid
+
 from resources import lrs_properties
 from tincan import (
     RemoteLRS,
@@ -14,6 +15,7 @@
     StateDocument,
 )
 
+
 # construct an LRS
 print "constructing the LRS..."
 lrs = RemoteLRS(
@@ -59,7 +61,7 @@
         name='Lord TinCan',
         mbox='mailto:lordtincan@tincanapi.com',
     ),
-    #language='en-US',
+    # language='en-US',
 )
 print "...done"
 
@@ -105,7 +107,7 @@
 # we can query our statements using an object
 # constructing the query object with common fields
 # note: more information about queries can be found in the API documentation:
-#   docs/build/html/tincan.html#module-tincan.remote_lrs
+# docs/build/html/tincan.html#module-tincan.remote_lrs
 query = {
     "agent": actor,
     "verb": verb,

setup.cfg

@@ -1,2 +1,5 @@
 [metadata]
 description-file = README.md
+
+[pep8]
+max-line-length = 120

test/about_test.py

@@ -1,4 +1,4 @@
-#    Copyright 2014 Rustici Software
+# Copyright 2014 Rustici Software
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -16,13 +16,13 @@
 
 if __name__ == '__main__':
     from main import setup_tincan_path
+
     setup_tincan_path()
 from test_utils import TinCanBaseTestCase
 from tincan import Version, About
 
 
 class AboutTest(TinCanBaseTestCase):
-
     def test_defaults(self):
         a = About()
         self.assertEqual(a.version, [Version.latest])
@@ -83,4 +83,4 @@ def test_bad_version_init(self):
 
 if __name__ == '__main__':
     suite = unittest.TestLoader().loadTestsFromTestCase(AboutTest)
-    unittest.TextTestRunner(verbosity=2).run(suite)
+    unittest.TextTestRunner(verbosity=2).run(suite)

test/activity_test.py

@@ -1,4 +1,4 @@
-#    Copyright 2014 Rustici Software
+# Copyright 2014 Rustici Software
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
 
 if __name__ == '__main__':
     from main import setup_tincan_path
+
     setup_tincan_path()
 from tincan import (
     Activity,
@@ -26,7 +27,6 @@
 
 
 class ActivityTest(unittest.TestCase):
-
     def test_InitEmpty(self):
         activity = Activity()
         self.assertIsNone(activity.id)
@@ -95,7 +95,7 @@ def test_ToJSONFromJSON(self):
 
     def test_ToJSON(self):
         check_str = '{"definition": {}, "id": "test", "objectType": "Activity"}'
-        activity = Activity(**{'id':'test', 'definition':{}, 'object_type':'Activity'})
+        activity = Activity(**{'id': 'test', 'definition': {}, 'object_type': 'Activity'})
         self.assertEqual(activity.to_json(), check_str)
 
     def test_setDefinitionException(self):
@@ -128,6 +128,7 @@ def activityVerificationHelper(self, activity):
         self.assertIsInstance(activity.definition, ActivityDefinition)
         self.assertEqual(activity.object_type, 'Activity')
 
+
 if __name__ == '__main__':
     suite = unittest.TestLoader().loadTestsFromTestCase(ActivityTest)
     unittest.TextTestRunner(verbosity=2).run(suite)