Added documentation, better coverage and generic tools

.gitignore

@@ -54,4 +54,6 @@ docs/_build/
 target/
 
 # Virtualenv
-.pyfreelan
+.pyfreelan2.7
+.pyfreelan3.3
+.pyfreelan3.4

.travis.yml

@@ -1,12 +1,16 @@
 language: python
 python:
   - "2.7"
+  - "3.3"
+  - "3.4"
 install:
   - pip install -r dev_requirements.txt
   - pip install --editable .
 script:
   - pep8 --count pyfreelan tests
-  - coverage run --source=pyfreelan setup.py nosetests --with-doctest
+  - coverage run --source=pyfreelan setup.py nosetests --with-doctest --doctest-extension=rst --tests tests,pyfreelan,doc/source
+  - sphinx-build -b doctest -W doc/source doc/build/html
+  - sphinx-build -b html -W doc/source doc/build/html
   - coverage report -m --fail-under=100
 after_success: coveralls
 notifications:

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+## Contributing
+
+Contributions to `pyfreelan` are most welcome ! However, please note that the
+continuous integration process enforces the following things:
+
+* All unit-tests/doc-tests must pass.
+* No pep8 error are found, neither in the code or the tests.
+* Coverage is 100%.
+
+You obviously need to write tests whenever you add/modify a feature. Don't
+forget to update the relevant documentation entries as well.
+
+This may seem crazy but I firmly believe that those things help maintain a
+higher code quality and reduce the chances of bugs.
+
+Feel free to ask for help if you are stuck writing tests or are not sure what
+to test/how to document.

README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/freelan-developers/pyfreelan.svg)](https://travis-ci.org/freelan-developers/pyfreelan)
+[![Documentation Status](https://readthedocs.org/projects/pyfreelan/badge/?version=latest)](https://readthedocs.org/projects/pyfreelan/?badge=latest)
 [![Coverage Status](https://coveralls.io/repos/freelan-developers/pyfreelan/badge.svg?branch=master)](https://coveralls.io/r/freelan-developers/pyfreelan?branch=master)
 [![Development Status](https://pypip.in/status/pyfreelan/badge.svg)](https://pypi.python.org/pypi/pyfreelan)
 [![Wheel Status](https://pypip.in/wheel/pyfreelan/badge.png?branch=master)](https://pypi.python.org/pypi/pyfreelan)
@@ -10,17 +11,3 @@
 
 A HTTP(s) client/server integration library for
 [freelan](http://www.freelan.org).
-
-## Contribution
-
-Contributions to `pyfreelan` are most welcome ! However, please note that the continuous integration process enforces the following things:
-
-* All unit-tests/doc-tests must pass.
-* No pep8 error are found, neither in the code or the tests.
-* Coverage is 100%.
-
-You obviously need to write tests whenever you add/modify a feature. Don't forget to update the relevant documentation entries as well.
-
-This may seem crazy but I firmly believe that those things help maintain a higher code quality and reduce the chances of bugs.
-
-Feel free to ask for help if you are stuck writing tests or are not sure what to test/how to document.

dev_requirements.txt

@@ -4,3 +4,7 @@ coverage >= 3.7.1, < 4
 coveralls == 0.5
 mock >= 1.0.1, < 2
 pep8 >= 1.5.7, < 2
+nose-parameterized == 0.3.5
+wheel == 0.24.0
+Sphinx >= 1.2.3, < 2
+sphinx-rtd-theme == 0.1.6

doc/source/conf.py

@@ -0,0 +1,286 @@
+# -*- coding: utf-8 -*-
+#
+# pyfreelan documentation build configuration file, created by
+# sphinx-quickstart on Tue Feb 10 18:40:21 2015.
+#
+# 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.
+
+import os
+import sphinx_rtd_theme
+
+# 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('.'))
+
+# -- 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',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'pyfreelan'
+copyright = u'2015, Julien Kauffmann'
+
+# 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 = open(
+    os.path.join(os.path.dirname(__file__), '..', '..', 'VERSION'),
+).read().strip()
+
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#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
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#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
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#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 = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = 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 = 'sphinx_rtd_theme'
+
+# 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 themes here, relative to this directory.
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#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
+
+# 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
+
+# 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']
+
+# 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 = []
+
+# 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'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is 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 = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pyfreelandoc'
+
+
+# -- 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': '',
+}
+
+# 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',
+        'pyfreelan.tex',
+        u'pyfreelan Documentation',
+        u'Julien Kauffmann',
+        'manual'
+    ),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'pyfreelan', u'pyfreelan Documentation',
+     [u'Julien Kauffmann'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- 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 = [
+    (
+        'index',
+        'pyfreelan',
+        u'pyfreelan Documentation',
+        u'Julien Kauffmann',
+        'pyfreelan',
+        'Provide color capabilities to Python logging.',
+        'Miscellaneous',
+    ),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
+
+# Autodocument classes methods.
+autoclass_content = 'both'

doc/source/index.rst

@@ -0,0 +1,18 @@
+PyFreeLAN's documentation
+=========================
+
+No documentation yet.
+
+Table of contents
+==================
+
+.. toctree::
+   :maxdepth: 3
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

hooks/README.md

@@ -0,0 +1,14 @@
+Git hooks
+=========
+
+A set of git hooks useful during development.
+
+Installation
+------------
+
+To install run `install.sh` on \*NIX and `install.bat` on Windows.
+
+Features
+--------
+
+* Adds a `git runtests` alias that runs the tests, as described in the `.travis.yml` file.