update documentations

Author: chfw

.travis.yml

@@ -15,12 +15,14 @@ python:
   - 3.4
   - 3.5
 before_install:
+  - cd $HOME
+  - "if [[ $TRAVIS_PYTHON_VERSION == 'pypy' ]]; then deactivate && wget https://bitbucket.org/squeaky/portable-pypy/downloads/pypy-5.7.1-linux_x86_64-portable.tar.bz2 -O - | tar -jxf - && echo 'Setting up aliases...' && ln -s pypy-5.7.1-linux_x86_64-portable pypy2-latest && export PATH=$HOME/pypy2-latest/bin/:$PATH && virtualenv --no-site-packages --python ~/pypy2-latest/bin/pypy pypy2-env && echo 'Creating custom env...' && source pypy2-env/bin/activate && python -V; fi"
+  - cd -
   - pip install pyramid==$PYRAMID_VERSION
   - if [[ $TRAVIS_PYTHON_VERSION == "2.6" ]]; then pip install flake8==2.6.2; fi
   - if [[ -f min_requirements.txt && "$MINREQ" -eq 1 ]]; then
       mv min_requirements.txt requirements.txt ;
     fi
-  - pip install --upgrade setuptools "pip==7.1"
   - test ! -f rnd_requirements.txt || pip install --no-deps -r rnd_requirements.txt
   - test ! -f rnd_requirements.txt || pip install -r rnd_requirements.txt ;
   - pip install -r tests/requirements.txt

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2016 by Onni Software Ltd. and its contributors
+Copyright (c) 2015-2017 by Onni Software Ltd. and its contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms of the software as well

README.rst

@@ -2,11 +2,14 @@
 pyramid-excel - Let you focus on data, instead of file formats
 ================================================================================
 
+.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png
+   :target: https://www.patreon.com/pyexcel
+
 .. image:: https://api.travis-ci.org/pyexcel/pyramid-excel.svg?branch=master
    :target: http://travis-ci.org/pyexcel/pyramid-excel
 
 .. image:: https://codecov.io/github/pyexcel/pyramid-excel/coverage.png
-    :target: https://codecov.io/github/pyexcel/pyramid-excel
+   :target: https://codecov.io/github/pyexcel/pyramid-excel
 
 .. image:: https://readthedocs.org/projects/pyramid-excel/badge/?version=latest
    :target: http://pyramid-excel.readthedocs.org/en/latest/
@@ -58,30 +61,34 @@ The highlighted features are:
 
 .. table:: A list of file formats supported by external plugins
 
-   ================= ======================= ============= ==================
-   Package name      Supported file formats  Dependencies  Python versions
-   ================= ======================= ============= ==================
-   `pyexcel-io`_     csv, csvz [#f1]_, tsv,                2.6, 2.7, 3.3,
-                     tsvz [#f2]_                           3.4, 3.5,
-                                                           pypy
-   `pyexcel-xls`_    xls, xlsx(read only),   `xlrd`_,      same as above
-                     xlsm(read only)         `xlwt`_
-   `pyexcel-xlsx`_   xlsx                    `openpyxl`_   same as above
-   `pyexcel-xlsxw`_  xlsx(write only)        `XlsxWriter`_ same as above
-   `pyexcel-ods3`_   ods                     `ezodf`_,     2.6, 2.7, 3.3, 3.4
-                                             lxml          3.5
-   `pyexcel-ods`_    ods                     `odfpy`_      same as above
-   `pyexcel-text`_   (write only)json, rst,  `tabulate`_   2.6, 2.7, 3.3, 3.4
-                     mediawiki, html,                      3.5, pypy, pypy3
-                     latex, grid, pipe,
-                     orgtbl, plain simple
-   ================= ======================= ============= ==================
+   ======================== ======================= =============== ==================
+   Package name              Supported file formats  Dependencies   Python versions
+   ======================== ======================= =============== ==================
+   `pyexcel-io`_            csv, csvz [#f1]_, tsv,                  2.6, 2.7, 3.3,
+                            tsvz [#f2]_                             3.4, 3.5, 3.6
+                                                                    pypy
+   `pyexcel-xls`_           xls, xlsx(read only),   `xlrd`_,        same as above
+                            xlsm(read only)         `xlwt`_
+   `pyexcel-xlsx`_          xlsx                    `openpyxl`_     same as above
+   `pyexcel-xlsxw`_         xlsx(write only)        `XlsxWriter`_   same as above
+   `pyexcel-ods3`_          ods                     `ezodf`_,       2.6, 2.7, 3.3, 3.4
+                                                    lxml            3.5, 3.6
+   `pyexcel-ods`_           ods                     `odfpy`_        same as above
+   `pyexcel-odsr`_          ods(read only)          lxml            same as above
+   `pyexcel-text`_          (write only)json, rst,  `tabulate`_     2.6, 2.7, 3.3, 3.4
+                            mediawiki, html,                        3.5, pypy, pypy3
+                            latex, grid, pipe,
+                            orgtbl, plain simple
+   `pyexcel-handsontable`_  handsontable in html    `handsontable`_ same as above
+   `pyexcel-pygal`_         svg chart               `pygal`_        same as above [#f3]_
+   ======================== ======================= =============== ==================
 
 .. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
 .. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls
 .. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx
 .. _pyexcel-ods: https://github.com/pyexcel/pyexcel-ods
 .. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3
+.. _pyexcel-odsr: https://github.com/pyexcel/pyexcel-odsr
 .. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw
 
 .. _xlrd: https://github.com/python-excel/xlrd
@@ -93,6 +100,21 @@ The highlighted features are:
 
 .. _pyexcel-text: https://github.com/pyexcel/pyexcel-text
 .. _tabulate: https://bitbucket.org/astanin/python-tabulate
+.. _pyexcel-handsontable: https://github.com/pyexcel/pyexcel-handsontable
+.. _handsontable: https://cdnjs.com/libraries/handsontable
+.. _pyexcel-pygal: https://github.com/pyexcel/pyexcel-chart
+.. _pygal: https://github.com/Kozea/pygal
+.. _pyexcel-matplotlib: https://github.com/pyexcel/pyexcel-matplotlib
+.. _matplotlib: https://matplotlib.org
+
+.. [#f3] coming soon
+
+In order to manage the list of plugins installed, you need to use pip to add or remove
+a plugin. When you use virtualenv, you can have different plugins per virtual
+environment. In the situation where you have multiple plugins that does the same thing
+in your environment, you need to tell pyexcel which plugin to use per function call.
+For example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr.
+You need to append get_array(..., library='pyexcel-odsr').
 
 .. rubric:: Footnotes
 
@@ -125,7 +147,7 @@ or clone it and install it:
 
 .. code-block:: bash
 
-    $ git clone http://github.com/pyexcel/pyramid-excel.git
+    $ git clone https://github.com/pyexcel/pyramid-excel.git
     $ cd pyramid-excel
     $ python setup.py install
 
@@ -144,6 +166,21 @@ adding it to the pyramid.includes list::
 
 
 
+Support the project
+================================================================================
+
+If your company has embedded pyexcel and its components into a revenue generating
+product, please `support me on patreon <https://www.patreon.com/bePatron?u=5537627>`_ to
+maintain the project and develop it further.
+
+If you are an individual, you are welcome to support me too on patreon and for however long
+you feel like to. As a patreon, you will receive
+`early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>`_.
+
+With your financial support, I will be able to invest
+a little bit more time in coding, documentation and writing interesting posts.
+
+
 Development guide
 ================================================================================
 
@@ -154,26 +191,46 @@ Development steps for code changes
 
 Upgrade your setup tools and pip. They are needed for development and testing only:
 
-#. pip install --upgrade setuptools "pip==7.1"
+#. pip install --upgrade setuptools pip
 
 Then install relevant development requirements:
 
 #. pip install -r rnd_requirements.txt # if such a file exists
 #. pip install -r requirements.txt
 #. pip install -r tests/requirements.txt
 
+Once you have finished your changes, please provide test case(s), relevant documentation
+and update CHANGELOG.rst.
 
-In order to update test environment, and documentation, additional setps are
-required:
+.. note::
 
-#. pip install moban
-#. git clone https://github.com/pyexcel/pyexcel-commons.git
-#. make your changes in `.moban.d` directory, then issue command `moban`
+    As to rnd_requirements.txt, usually, it is created when a dependent
+	library is not released. Once the dependecy is installed
+	(will be released), the future
+	version of the dependency in the requirements.txt will be valid.
 
-What is rnd_requirements.txt
--------------------------------
 
-Usually, it is created when a dependent library is not released. Once the dependecy is installed(will be released), the future version of the dependency in the requirements.txt will be valid.
+How to test your contribution
+------------------------------
+
+Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.
+
+On Linux/Unix systems, please launch your tests like this::
+
+    $ make
+
+On Windows systems, please issue this command::
+
+    > test.bat
+
+How to update test environment and update documentation
+---------------------------------------------------------
+
+Additional steps are required:
+
+#. pip install moban
+#. git clone https://github.com/pyexcel/pyexcel-commons.git commons
+#. make your changes in `.moban.d` directory, then issue command `moban`
 
 What is pyexcel-commons
 ---------------------------------
@@ -185,18 +242,16 @@ What is .moban.d
 
 `.moban.d` stores the specific meta data for the library.
 
-How to test your contribution
-------------------------------
-
-Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.
+Acceptance criteria
+-------------------
 
-On Linux/Unix systems, please launch your tests like this::
-
-    $ make test
+#. Has Test cases written
+#. Has all code lines tested
+#. Passes all Travis CI builds
+#. Has fair amount of documentation if your change is complex
+#. Agree on NEW BSD License for your contribution
 
-On Windows systems, please issue this command::
 
-    > test.bat
 
 License
 ================================================================================

docs/source/conf.py

@@ -1,4 +1,9 @@
 # -*- coding: utf-8 -*-
+DESCRIPTION = (
+    'A pyramid extension that provides one application programming interfac' +
+    'e to read and write data in different excel file formats' +
+    ''
+)
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
@@ -7,15 +12,15 @@
 ]
 
 intersphinx_mapping = {
-    'pyexcel': ('http://pyexcel.readthedocs.org/en/latest/', None)
+    'pyexcel': ('http://pyexcel.readthedocs.org/en/latest/', None),
 }
 spelling_word_list_filename = 'spelling_wordlist.txt'
 templates_path = ['_templates']
 source_suffix = '.rst'
 master_doc = 'index'
 
 project = u'pyramid-excel'
-copyright = u'2015-2016 Onni Software Ltd.'
+copyright = u'2015-2017 Onni Software Ltd.'
 version = '0.0.3'
 release = '0.0.4'
 exclude_patterns = []
@@ -27,15 +32,19 @@
 htmlhelp_basename = 'pyramid-exceldoc'
 latex_elements = {}
 latex_documents = [
-    ('index', 'pyramid-excel.tex', u'pyramid-excel Documentation',
+    ('index', 'pyramid-excel.tex',
+     'pyramid-excel Documentation',
      'Onni Software Ltd.', 'manual'),
 ]
 man_pages = [
-    ('index', 'pyramid-excel', u'pyramid-excel Documentation',
+    ('index', 'pyramid-excel',
+     'pyramid-excel Documentation',
      [u'Onni Software Ltd.'], 1)
 ]
 texinfo_documents = [
-    ('index', 'pyramid-excel', u'pyramid-excel Documentation',
-     'Onni Software Ltd.', 'pyramid-excel', 'One line description of project.',
+    ('index', 'pyramid-excel',
+     'pyramid-excel Documentation',
+     'Onni Software Ltd.', 'pyramid-excel',
+     DESCRIPTION,
      'Miscellaneous'),
 ]

docs/source/index.rst

@@ -56,30 +56,34 @@ The highlighted features are:
 
 .. table:: A list of file formats supported by external plugins
 
-   ================= ======================= ============= ==================
-   Package name      Supported file formats  Dependencies  Python versions
-   ================= ======================= ============= ==================
-   `pyexcel-io`_     csv, csvz [#f1]_, tsv,                2.6, 2.7, 3.3,
-                     tsvz [#f2]_                           3.4, 3.5,
-                                                           pypy
-   `pyexcel-xls`_    xls, xlsx(read only),   `xlrd`_,      same as above
-                     xlsm(read only)         `xlwt`_
-   `pyexcel-xlsx`_   xlsx                    `openpyxl`_   same as above
-   `pyexcel-xlsxw`_  xlsx(write only)        `XlsxWriter`_ same as above
-   `pyexcel-ods3`_   ods                     `ezodf`_,     2.6, 2.7, 3.3, 3.4
-                                             lxml          3.5
-   `pyexcel-ods`_    ods                     `odfpy`_      same as above
-   `pyexcel-text`_   (write only)json, rst,  `tabulate`_   2.6, 2.7, 3.3, 3.4
-                     mediawiki, html,                      3.5, pypy, pypy3
-                     latex, grid, pipe,
-                     orgtbl, plain simple
-   ================= ======================= ============= ==================
+   ======================== ======================= =============== ==================
+   Package name              Supported file formats  Dependencies   Python versions
+   ======================== ======================= =============== ==================
+   `pyexcel-io`_            csv, csvz [#f1]_, tsv,                  2.6, 2.7, 3.3,
+                            tsvz [#f2]_                             3.4, 3.5, 3.6
+                                                                    pypy
+   `pyexcel-xls`_           xls, xlsx(read only),   `xlrd`_,        same as above
+                            xlsm(read only)         `xlwt`_
+   `pyexcel-xlsx`_          xlsx                    `openpyxl`_     same as above
+   `pyexcel-xlsxw`_         xlsx(write only)        `XlsxWriter`_   same as above
+   `pyexcel-ods3`_          ods                     `ezodf`_,       2.6, 2.7, 3.3, 3.4
+                                                    lxml            3.5, 3.6
+   `pyexcel-ods`_           ods                     `odfpy`_        same as above
+   `pyexcel-odsr`_          ods(read only)          lxml            same as above
+   `pyexcel-text`_          (write only)json, rst,  `tabulate`_     2.6, 2.7, 3.3, 3.4
+                            mediawiki, html,                        3.5, pypy, pypy3
+                            latex, grid, pipe,
+                            orgtbl, plain simple
+   `pyexcel-handsontable`_  handsontable in html    `handsontable`_ same as above
+   `pyexcel-pygal`_         svg chart               `pygal`_        same as above [#f3]_
+   ======================== ======================= =============== ==================
 
 .. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
 .. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls
 .. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx
 .. _pyexcel-ods: https://github.com/pyexcel/pyexcel-ods
 .. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3
+.. _pyexcel-odsr: https://github.com/pyexcel/pyexcel-odsr
 .. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw
 
 .. _xlrd: https://github.com/python-excel/xlrd
@@ -91,6 +95,21 @@ The highlighted features are:
 
 .. _pyexcel-text: https://github.com/pyexcel/pyexcel-text
 .. _tabulate: https://bitbucket.org/astanin/python-tabulate
+.. _pyexcel-handsontable: https://github.com/pyexcel/pyexcel-handsontable
+.. _handsontable: https://cdnjs.com/libraries/handsontable
+.. _pyexcel-pygal: https://github.com/pyexcel/pyexcel-chart
+.. _pygal: https://github.com/Kozea/pygal
+.. _pyexcel-matplotlib: https://github.com/pyexcel/pyexcel-matplotlib
+.. _matplotlib: https://matplotlib.org
+
+.. [#f3] coming soon
+
+In order to manage the list of plugins installed, you need to use pip to add or remove
+a plugin. When you use virtualenv, you can have different plugins per virtual
+environment. In the situation where you have multiple plugins that does the same thing
+in your environment, you need to tell pyexcel which plugin to use per function call.
+For example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr.
+You need to append get_array(..., library='pyexcel-odsr').
 
 .. rubric:: Footnotes
 
@@ -122,7 +141,7 @@ or clone it and install it:
 
 .. code-block:: bash
 
-    $ git clone http://github.com/pyexcel/pyramid-excel.git
+    $ git clone https://github.com/pyexcel/pyramid-excel.git
     $ cd pyramid-excel
     $ python setup.py install
 
@@ -214,6 +233,23 @@ And you can start the tiny server by this command, assuming you have save it as
         serving on http://127.0.0.1:5000
 
 
+
+Support the project
+-----------------------
+
+If your company has embedded pyexcel and its components into a revenue generating
+product, please `support me on patreon <https://www.patreon.com/bePatron?u=5537627>`_ to
+maintain the project and develop it further.
+
+If you are an individual, you are welcome to support me too on patreon and for however long
+you feel like to. As a patreon, you will receive
+`early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>`_.
+
+With your financial support, I will be able to invest
+a little bit more time in coding, documentation and writing interesting posts.
+
+
+
 More excel file formats
 ------------------------