================================================================================ pyexcel-cli - Let you focus on data at command line, instead of file formats

.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png :target: https://www.patreon.com/chfw

.. image:: https://travis-ci.org/pyexcel/pyexcel-cli.svg?branch=master :target: http://travis-ci.org/pyexcel/pyexcel-cli

.. image:: https://codecov.io/gh/pyexcel/pyexcel-cli/branch/master/graph/badge.svg :target: https://codecov.io/gh/pyexcel/pyexcel-cli

.. image:: https://badge.fury.io/py/pyexcel-cli.svg :target: https://pypi.org/project/pyexcel-cli

.. image:: https://pepy.tech/badge/pyexcel-cli/month :target: https://pepy.tech/project/pyexcel-cli/month

.. 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 github <https://github.com/sponsors/chfw>, patreon <https://www.patreon.com/bePatron?u=5537627> or bounty source <https://salt.bountysource.com/teams/chfw-pyexcel>_ to maintain the project and develop it further.

If you are an individual, you are welcome to support me too and for however long you feel like. As my backer, you will receive early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>_.

And your issues will get prioritized if you would like to become my patreon as pyexcel pro user.

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. This library can turn the excel data into a list of lists, a list of records(dictionaries), dictionaries of lists. And vice versa. Hence it lets you focus on data in shell programming, instead of file formats.

Hightlighted features:

#. View data in the excel files without Microsoft Office or Open Office #. Transcode data among supported excel file formats #. Merge files in various excel file formats into one #. Split a multi-sheet excel file into single sheet files #. Find difference in data between two excel files

Usage

.. code-block:: bash

$ cd demo $ pyexcel view --in-browser --output-file-type sortable.html --sheet-index 0 https://github.com/pyexcel/excel2table/raw/master/sample/goog.ods

Here's what you will get:

.. image:: https://github.com/pyexcel/pyexcel-cli/raw/master/pyexcel-cli-sortable.gif

.. note::

You will need to install pyexcel-sortable, which renders it.

Here is another cli example usage:

.. code-block:: bash

$ pyexcel view https://github.com/pyexcel/pyexcel-cli/blob/master/tests/fixtures/multiple-sheets.xls
Sheet 1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
| 7 | 8 | 9 |
+---+---+---+
Sheet 2:
+---+---+---+
| X | Y | Z |
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Sheet 3:
+---+---+---+
| O | P | Q |
+---+---+---+
| 3 | 2 | 1 |
+---+---+---+
| 4 | 3 | 2 |
+---+---+---+

Because pyexcel family is loosely coupled, especially for file format supports, you install the libraries that you need to. If you need to support xls format, you will need to install pyexcel-xls. For more information, please see the plugin section.

.. _file-format-list: .. _a-map-of-plugins-and-file-formats:

.. 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, 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-ods3_ ods pyexcel-ezodf, 2.6, 2.7, 3.3, 3.4 lxml 3.5, 3.6 pyexcel-ods ods odfpy_ same as above ======================== ======================= ================= ==================

.. table:: Dedicated file reader and writers

======================== ======================= ================= ================== Package name Supported file formats Dependencies Python versions ======================== ======================= ================= ================== pyexcel-xlsxw_ xlsx(write only) XlsxWriter_ Python 2 and 3 pyexcel-xlsxr_ xlsx(read only) lxml same as above pyexcel-xlsbr_ xlsx(read only) pyxlsb same as above pyexcel-odsr_ read only for ods, fods lxml same as above pyexcel-odsw_ write only for ods loxun same as above pyexcel-htmlr_ html(read only) lxml,html5lib same as above pyexcel-pdfr_ pdf(read only) pdftables Python 2 only. ======================== ======================= ================= ==================

.. _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-odsw: https://github.com/pyexcel/pyexcel-odsw .. _pyexcel-pdfr: https://github.com/pyexcel/pyexcel-pdfr

.. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw .. _pyexcel-xlsxr: https://github.com/pyexcel/pyexcel-xlsxr .. _pyexcel-xlsbr: https://github.com/pyexcel/pyexcel-xlsbr .. _pyexcel-htmlr: https://github.com/pyexcel/pyexcel-htmlr

.. _xlrd: https://github.com/python-excel/xlrd .. _xlwt: https://github.com/python-excel/xlwt .. _openpyxl: https://bitbucket.org/openpyxl/openpyxl .. _XlsxWriter: https://github.com/jmcnamara/XlsxWriter .. _pyexcel-ezodf: https://github.com/pyexcel/pyexcel-ezodf .. _odfpy: https://github.com/eea/odfpy

.. table:: Other data renderers

======================== ======================= ================= ================== Package name Supported file formats Dependencies Python versions ======================== ======================= ================= ================== pyexcel-text_ write only:rst, tabulate_ 2.6, 2.7, 3.3, 3.4 mediawiki, html, 3.5, 3.6, pypy latex, grid, pipe, orgtbl, plain simple read only: ndjson r/w: json 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-gantt_ gantt chart in html frappe-gantt_ except pypy, same as above ======================== ======================= ================= ==================

.. _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 .. _pyexcel-sortable: https://github.com/pyexcel/pyexcel-sortable .. _csvtotable: https://github.com/vividvilla/csvtotable .. _pyexcel-gantt: https://github.com/pyexcel/pyexcel-gantt .. _frappe-gantt: https://github.com/frappe/gantt

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

.. [#f1] zipped csv file .. [#f2] zipped tsv file

Installation

You can install pyexcel-cli via pip:

.. code-block:: bash

$ pip install pyexcel-cli

or clone it and install it:

.. code-block:: bash

$ git clone https://github.com/pyexcel/pyexcel-cli.git
$ cd pyexcel-cli
$ python setup.py install

Development guide

Development steps for code changes

#. git clone https://github.com/pyexcel/pyexcel-cli.git #. cd pyexcel-cli

Upgrade your setup tools and pip. They are needed for development and testing only:

#. 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.

.. 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

Additional steps are required:

#. pip install moban #. make your changes in .moban.d directory, then issue command moban

What is pyexcel-commons

Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in pyexcel-commons project.

What is .moban.d

.moban.d stores the specific meta data for the library.

License

New BSD License