Merge branch 'master' into cuducos-coveralls (fix conflict after #63)

LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2016 Serenata de Amor
+MIT License
+
+Copyright (c) 2016 Data Science Brigade
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -7,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.rst

@@ -10,54 +10,59 @@
    :target: https://landscape.io/github/datasciencebr/serenata-toolbox/master
    :alt: Code Health
 
-.. image:: https://img.shields.io/pypi/v/serenata_toolbox.svg
-   :target: https://pypi.python.org/pypi/serenata_toolbox/
-   :alt: Latest PyPI version
-
 .. image:: https://coveralls.io/repos/github/datasciencebr/serenata-toolbox/badge.svg?branch=master
    :target: https://coveralls.io/github/datasciencebr/serenata-toolbox?branch=master
    :alt: Coveralls
 
 Serenata de Amor Toolbox
 ========================
 
-`PyPI <https://pypi.python.org/>`_  package to support `Serenata de Amor <https://github.com/datasciencebr/serenata-de-amor>`_
+`pip <https://pip.pypa.io/en/stable/>`_  installable package to support `Serenata de Amor <https://github.com/datasciencebr/serenata-de-amor>`_
 and `Rosie <https://github.com/datasciencebr/rosie>`_ development.
 
+Serenata_toolbox is compatible with Python 3+
 
 Installation
 ------------
 
-As this is a work in progress, clone the repo and use it within your virtualenv.
+::
+
+    $ pip install git+https://github.com/datasciencebr/serenata-toolbox.git#egg=serenata-toolbox 
+
+Development
+------------
+
+Clone the repo and use it within your virtualenv.
 
 ::
 
   $ git clone https://github.com/datasciencebr/serenata-toolbox.git
   $ python setup.py develop
 
-serenata_toolbox is compatible with Python 3+
+We use `Elm's philosophy <https://github.com/elm-lang/elm-package#version-rules>`_ for version bumping:
+
+* MICRO: the API is the same, no risk of breaking code
+* MINOR: values have been added, existing values are unchanged
+* MAJOR: existing values have been changed or removed
 
 Usage
 -----
 
-If you plan to upload data to a S3 server you should copy `config.ini.example` as `config.ini` and edit it with your own credentials.
+Copy `config.ini.example` as `config.ini` and edit it with your own credentials. If you don't plan to upload anything to S3 please don't bother about keys and secrets in this file.
+
+Example:
 
 .. code:: python
 
   $ python3
-  >>> from serenata_toolbox import xml2csv
-  >>> xml2csv.output('Spam and eggs')
-  2016-12-01 18:14:26 Spam and eggs
-
-Full Documentation
-------------------
-
-https://serenata_toolbox.readthedocs.io
+  >>> from serenata_toolbox.datasets import Dataset
+  >>> dataset = Dataset('/tmp/serenata-data')
+  >>> tuple(dataset.local.all)
 
-Build documentation locally
----------------------------
+Documentation (WIP)
+-------------------
 
-You will need sphinx installed in your machine
+The `full documentation <https://serenata_toolbox.readthedocs.io>`_ is still a work in progress. If you wanna give us a hand you will need `Sphinx <http://www.sphinx-doc.org/>`_:
 
 ::
 
@@ -77,8 +82,3 @@ Source Code
 Feel free to fork, evaluate and contribute to this project.
 
 Source: https://github.com/datasciencebr/serenata-toolbox/
-
-License
--------
-
-MIT licensed.