Merged in develop (pull request #22)

Updating master branch with latest from develop

Approved-by: David Cuesta <david.cuesta@shapelets.io>

.gitattributes

@@ -0,0 +1 @@
+* text eol=lf

.gitignore

@@ -98,4 +98,10 @@ ENV/
 /site
 
 # mypy
-.mypy_cache/
+.mypy_cache/
+
+#documentation
+./docs/build/
+
+#IntelliJ files.
+.idea

AUTHORS.rst

@@ -0,0 +1,15 @@
+Authors
+==========
+
+
+Core Development Team
+---------------------
+
+- Cuesta Merino, David (`david.cuesta@shapelets.io <david.cuesta@shapelets.io>`_)
+- Ruíz-Ferrer, Justo  (`justo.ruiz@shapelets.io <justo.ruiz@shapelets.io>`_)
+- Torreño Tirado, Óscar (`oscar.torreno@shapelets.io <oscar.torreno@shapelets.io>`_)
+- Vilches Reina, Antonio (`antonio.vilches@shapelets.io <antonio.vilches@shapelets.io>`_)
+
+Contributions
+-------------
+- Sánchez de Ybargüen, Luis (`luis.sanchez@shapelets.io <luis.sanchez@shapelets.io>`_)

CHANGES.rst

@@ -0,0 +1,10 @@
+=========
+Changelog
+=========
+
+KHIVA uses `Semantic Versioning <http://semver.org/>`_
+
+
+Version 0.1.0
+==============
+- Initial version

README.md

@@ -1,32 +1,47 @@
 # README #
-
-This is the TSA library for Python. 
-This project provides the Python wrapper for the original TSA library written in C++ programming language. 
-
-### What is this repository for? ###
-
-* This repository provides the full installable Python Package for using the TSA library with the target of analyse 
-time series in a super-efficient fashion, giving a solution for time series analysis in the Big Data Ecosystem. 
-
-
-
-### How do I get set up? ###
-
-* For installing this package, please, first it is necessary to satisfy the reuqirements indicated in the requirements.txt file.
-
-* Configuration
-* Dependencies
-* Database configuration
-* How to run tests
-* Deployment instructions
-
-### Contribution guidelines ###
-
-* Writing tests
-* Code review
-* Other guidelines
-
-### Who do I talk to? ###
-
-* Repo owner or admin
-* Other community or team contact
+This is the KHIVA binding for connecting the Python programming language and the KHIVA library.
+
+## License
+This project is licensed under [MPL-v2](https://www.mozilla.org/en-US/MPL/2.0/).
+
+## Quick Summary
+This Python library called 'khiva' provides all the functionalities of the KHIVA library for time series analytics.
+
+## Set up
+It is just needed to execute the next command in the root directory of the project:
+```bash
+python3 setup.py install
+```
+
+## Executing the tests:
+The tests can be executed and they are located in <project-root-dir>/tests/unit_tests.
+
+## Documentation
+This Python library follows the standard way of writing documentation of Python by using Sphinx.
+
+In order to generate the documentation (in html format), run the following command under the <project-root-dir>/docs folder:
+```bash
+make html
+```
+
+## Contributing
+
+### Branching model
+Our branching model has two permanent branches, **develop** and **master**. 
+We aim at using `develop` as the main branch, where all features are merged. 
+In this sense, we use the master branch to push the release versions of the binding for the KHIVA library.
+
+### Contribution process
+In order to contribute to the code base, we follow the next process:
+1. The main branch is develop, every developer should pull the current status of the branch before stating to develop any new feature.
+`git pull`
+2. Create a new branch with the following pattern "feature/[name_of_the_feature]"
+`git checkout -b feature/exampleFeature`
+3. Develop the new feature on the the new branch. It includes testing and documentation.
+`git commit -a -m "Bla, Bla, Bla";  git push`
+4. Open a Pull Request to merge the feature branch in to develop. Currently, a pull request has to be reviewed at least by one person.
+5. Finally, delete the feature branch.
+6. Move back to develop branch.
+`git checkout develop`
+7. Pull the latest changes.
+`git pull`

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = khiva
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source/authors.rst

@@ -0,0 +1,2 @@
+.. _authors:
+.. include:: ../../AUTHORS.rst

docs/source/changes.rst

@@ -0,0 +1,2 @@
+.. _changes:
+.. include:: ../../CHANGES.rst

docs/source/conf.py

@@ -0,0 +1,161 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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
+import subprocess
+
+sys.path.insert(0, os.path.abspath('../..'))
+
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'khiva'
+copyright = '2018, Shapelets'
+author = 'Shapelets.io'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = subprocess.check_output(["git", "describe"]).strip().decode("utf-8").split('-')[0]
+
+
+# -- 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.mathjax',
+]
+
+# 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'
+
+# 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 pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- 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 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.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'khivadoc'
+
+
+# -- 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, 'khiva.tex', 'khiva Documentation', '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, 'khiva', 'khiva 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, 'khiva', 'khiva Documentation',
+     author, 'khiva', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+# -- Extension configuration -------------------------------------------------

docs/source/index.rst

@@ -0,0 +1,27 @@
+.. khiva documentation master file, created by
+   sphinx-quickstart on Thu Apr  5 13:28:29 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to KHIVA's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Contents:
+   :numbered:
+
+   Quick Start <text/quick_start>
+   Modules <modules>
+   FAQ <text/faq>
+   Authors <authors>
+   License <license>
+   Changelog <changes>
+   How to contribute <text/how_to_contribute>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`