add demo gif

Author: chfw

.moban.d/cli-feature.rst.jj2

@@ -15,6 +15,8 @@ Hightlighted features:
 Usage
 ================================================================================
 
+.. image:: https://github.com/pyexcel/pyexcel-cli/raw/master/pyexcel-cli.gif
+
 Here is an example usage:
 
 .. code-block:: bash

README.rst

@@ -11,14 +11,34 @@ pyexcel-cli - Let you focus on data at command line, instead of file formats
 .. image:: https://codecov.io/github/pyexcel/pyexcel-cli/coverage.png
    :target: https://codecov.io/github/pyexcel/pyexcel-cli
 
+.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
+   :target: https://gitter.im/pyexcel/Lobby
+
 .. image:: https://readthedocs.org/projects/pyexcel-cli/badge/?version=latest
    :target: http://pyexcel-cli.readthedocs.org/en/latest/
 
+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.
+
+
 Known constraints
 ==================
 
 Fonts, colors and charts are not supported.
 
+Introduction
+================================================================================
 
 **pyexcel-cli** brings `pyexcel <https://github.com/pyexcel/pyexcel>`_ to make it easy
 to consume/produce information stored in excel files on command line interface.
@@ -37,6 +57,8 @@ Hightlighted features:
 Usage
 ================================================================================
 
+.. image:: https://github.com/pyexcel/pyexcel-cli/raw/master/pyexcel-cli.gif
+
 Here is an example usage:
 
 .. code-block:: bash
@@ -90,11 +112,13 @@ need to install pyexcel-xls. For more information, please see the plugin section
    `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
+                            mediawiki, html,                        3.5, 3.6, pypy
                             latex, grid, pipe,
                             orgtbl, plain simple
-   `pyexcel-handsontable`_  handsontable in html    `handsontable`_ same as above [#f3]_
-   `pyexcel-pygal`_         svg chart               `pygal`_        same as above [#f3]_
+   `pyexcel-handsontable`_  handsontable in html    `handsontable`_ same as above
+   `pyexcel-pygal`_         svg chart               `pygal`_        2.7, 3.3, 3.4, 3.5
+                                                                    3.6, pypy
+   `pyexcel-sortable`_      sortable table in html  `csvtotable`_   same as above
    ======================== ======================= =============== ==================
 
 .. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
@@ -120,8 +144,9 @@ need to install pyexcel-xls. For more information, please see the plugin section
 .. _pygal: https://github.com/Kozea/pygal
 .. _pyexcel-matplotlib: https://github.com/pyexcel/pyexcel-matplotlib
 .. _matplotlib: https://matplotlib.org
+.. _pyexcel-sortable: https://github.com/pyexcel/pyexcel-sortable
+.. _csvtotable: https://github.com/vividvilla/csvtotable
 
-.. [#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
@@ -157,21 +182,6 @@ or clone it and install it:
 
 
 
-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
 ================================================================================
 
@@ -190,19 +200,39 @@ Then install relevant development requirements:
 #. 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.
+
+.. note::
+
+    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.
+
+
+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
+---------------------------------------------------------
 
-In order to update test environment, and documentation, additional steps are
-required:
+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 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 pyexcel-commons
 ---------------------------------
 
@@ -213,18 +243,16 @@ What is .moban.d
 
 `.moban.d` stores the specific meta data for the library.
 
-How to test your contribution
-------------------------------
+Acceptance criteria
+-------------------
 
-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::
+#. 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
 
-    $ make
 
-On Windows systems, please issue this command::
-
-    > test.bat
 
 
 License

docs/source/conf.py

@@ -12,7 +12,7 @@
 ]
 
 intersphinx_mapping = {
-    'pyexcel': ('http://pyexcel.readthedocs.org/en/latest/', None),
+    'pyexcel': ('http://pyexcel.readthedocs.io/en/latest/', None),
 }
 spelling_word_list_filename = 'spelling_wordlist.txt'
 templates_path = ['_templates']

docs/source/index.rst

@@ -29,6 +29,8 @@ Hightlighted features:
 Usage
 ================================================================================
 
+.. image:: https://github.com/pyexcel/pyexcel-cli/raw/master/pyexcel-cli.gif
+
 Here is an example usage:
 
 .. code-block:: bash
@@ -103,11 +105,13 @@ List of plugins
    `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
+                            mediawiki, html,                        3.5, 3.6, pypy
                             latex, grid, pipe,
                             orgtbl, plain simple
-   `pyexcel-handsontable`_  handsontable in html    `handsontable`_ same as above [#f3]_
-   `pyexcel-pygal`_         svg chart               `pygal`_        same as above [#f3]_
+   `pyexcel-handsontable`_  handsontable in html    `handsontable`_ same as above
+   `pyexcel-pygal`_         svg chart               `pygal`_        2.7, 3.3, 3.4, 3.5
+                                                                    3.6, pypy
+   `pyexcel-sortable`_      sortable table in html  `csvtotable`_   same as above
    ======================== ======================= =============== ==================
 
 .. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
@@ -133,8 +137,9 @@ List of plugins
 .. _pygal: https://github.com/Kozea/pygal
 .. _pyexcel-matplotlib: https://github.com/pyexcel/pyexcel-matplotlib
 .. _matplotlib: https://matplotlib.org
+.. _pyexcel-sortable: https://github.com/pyexcel/pyexcel-sortable
+.. _csvtotable: https://github.com/vividvilla/csvtotable
 
-.. [#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

pyexcel-cli.gif

@@ -10,7 +10,7 @@
 
 NAME = 'pyexcel-cli'
 AUTHOR = 'C.W.'
-VERSION = '0.0.2'
+VERSION = ''
 EMAIL = '[email protected]'
 LICENSE = 'New BSD'
 ENTRY_POINTS = {