Performance improvements, documentation cleanup

.gitignore

@@ -1,3 +1,6 @@
 *~
 /build/
-*.pyc
+*.pyc
+_build/
+test/*.tdb
+

README.md

@@ -49,4 +49,18 @@ Or, you can run the docker image with your password (yourPassword), and your jup
 
     $ docker run -e PASSWORD=yourPassword -p 8080:8888 -it c3h3/traildb-ipynb
 
-Easily to use [http://localhost:8080](http://localhost:8080) to access your jupyter notebook
+Easily to use [http://localhost:8080](http://localhost:8080) to access your jupyter notebook
+
+#### Documentation
+
+Sphinx documentation is available.
+
+1. Ensure Sphinx is installed.
+
+`pip install sphinx`
+
+2. Generate HTML documentation.
+
+`sphinx-build -b html . _build`
+
+Open `_build/index.html` in a browser.

conf.py

@@ -0,0 +1,171 @@
+# -*- coding: utf-8 -*-
+#
+# traildb-python documentation build configuration file, created by
+# sphinx-quickstart on Mon Oct  2 14:22:22 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# 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
+# ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'traildb-python'
+copyright = u'2017, AdRoll Inc'
+author = u'AdRoll Inc'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'0.1.0'
+# The full version, including alpha/beta/rc tags.
+release = u'0.1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# 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 = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'traildb-pythondoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# 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 = [
+    (master_doc, 'traildb-python.tex', u'traildb-python Documentation',
+     u'AdRoll Inc', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'traildb-python', u'traildb-python Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'traildb-python', u'traildb-python Documentation',
+     author, 'traildb-python', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

index.rst

@@ -0,0 +1,34 @@
+.. traildb-python documentation master file, created by
+   sphinx-quickstart on Mon Oct  2 14:17:29 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+traildb-python
+==============
+
+These are Python 2 bindings to TrailDB. Official TrailDB website is at http://traildb.io/
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. autoclass:: traildb.TrailDB
+   :members:
+
+.. autoclass:: traildb.TrailDBConstructor
+   :members:
+
+.. autoclass:: traildb.TrailDBCursor
+   :members:
+
+.. autoclass:: traildb.TrailDBEventFilter
+   :members:
+
+.. autoclass:: traildb.TrailDBError
+   :members:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`

test/test.py

@@ -39,6 +39,9 @@ def test_trails(self):
             self.assertTrue(hasattr(event, 'field1'))
             self.assertTrue(hasattr(event, 'field2'))
 
+            with self.assertRaises(AttributeError):
+                event.missing_field
+
     def test_trails_selected_uuids(self):
         uuids = ["02345678123456781234567812345678",
                  "12345678123456781234567812345678",
@@ -51,12 +54,12 @@ def test_trails_selected_uuids(self):
             cons.add(uuid, 2, ['b', '2'])
             cons.add(uuid, 3, ['c', '3'])
         cons.finalize()
-        
+
         tdb = TrailDB('whitelist_testtrail')
         whitelist = [uuids[0],
                      uuids[3],
                      uuids[4]]
-        
+
         expected_length = 3
         for trail_uuid, trail_events in tdb.trails(selected_uuids=whitelist):
             trail_events = list(trail_events)
@@ -129,7 +132,7 @@ def test_apply_whitelist(self):
             cons.add(uuid, 2, ['b', '2'])
             cons.add(uuid, 3, ['c', '3'])
         cons.finalize()
-        
+
         tdb = TrailDB('whitelist_testtrail')
         whitelist = [uuids[0],
                      uuids[3],
@@ -143,7 +146,7 @@ def test_apply_whitelist(self):
                 expected_length = 3
             else:
                 expected_length = 0
-                
+
             trail_events = list(trail_events)
             self.assertEqual(len(trail_events),
                              expected_length)
@@ -160,7 +163,7 @@ def test_apply_blacklist(self):
             cons.add(uuid, 2, ['b', '2'])
             cons.add(uuid, 3, ['c', '3'])
         cons.finalize()
-        
+
         tdb = TrailDB('blacklist_testtrail')
         blacklist = [uuids[1],
                      uuids[2]]
@@ -172,7 +175,7 @@ def test_apply_blacklist(self):
                 expected_length = 0
             else:
                 expected_length = 3
-                
+
             trail_events = list(trail_events)
             self.assertEqual(len(trail_events),
                              expected_length)
@@ -189,7 +192,7 @@ def test_apply_whitelist(self):
             cons.add(uuid, 2, ['b', '2'])
             cons.add(uuid, 3, ['c', '3'])
         cons.finalize()
-        
+
         tdb = TrailDB('whitelist_testtrail')
         whitelist = [uuids[0],
                      uuids[3],
@@ -203,7 +206,7 @@ def test_apply_whitelist(self):
                 expected_length = 3
             else:
                 expected_length = 0
-                
+
             trail_events = list(trail_events)
             self.assertEqual(len(trail_events),
                              expected_length)
@@ -220,7 +223,7 @@ def test_apply_blacklist(self):
             cons.add(uuid, 2, ['b', '2'])
             cons.add(uuid, 3, ['c', '3'])
         cons.finalize()
-        
+
         tdb = TrailDB('blacklist_testtrail')
         blacklist = [uuids[1],
                      uuids[2]]
@@ -232,7 +235,7 @@ def test_apply_blacklist(self):
                 expected_length = 0
             else:
                 expected_length = 3
-                
+
             trail_events = list(trail_events)
             self.assertEqual(len(trail_events),
                              expected_length)