Package: pyexcel-cli
Support the projectIf your company has embedded pyexcel and its components into a revenue generating
product, pleasesupport me on patreonto
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 receiveearly access to pyexcel related contents.With your financial support, I will be able to invest
a little bit more time in coding, documentation and writing interesting posts.Known constraintsFonts, colors and charts are not supported.Introductionpyexcel-clibringspyexcelto 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 OfficeTranscode data among supported excel file formatsMerge files in various excel file formats into oneSplit a multi-sheet excel file into single sheet filesFind difference in data between two excel filesUsage$cddemo$pyexcelview--in-browser--output-file-typesortable.html--sheet-index0https://github.com/pyexcel/excel2table/raw/master/sample/goog.odsHere’s what you will get:NoteYou will need to install pyexcel-sortable, which renders it.Here is another cli example usage:$pyexcelviewhttps://github.com/pyexcel/pyexcel-cli/blob/master/tests/fixtures/multiple-sheets.xlsSheet1:+---+---+---+|1|2|3|+---+---+---+|4|5|6|+---+---+---+|7|8|9|+---+---+---+Sheet2:+---+---+---+|X|Y|Z|+---+---+---+|1|2|3|+---+---+---+|4|5|6|+---+---+---+Sheet3:+---+---+---+|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:A list of file formats supported by external pluginsPackage nameSupported file formatsDependenciesPython versionspyexcel-iocsv, csvz[1], tsv,
tsvz[2]2.6, 2.7, 3.3,
3.4, 3.5, 3.6
pypypyexcel-xlsxls, xlsx(read only),
xlsm(read only)xlrd,xlwtsame as abovepyexcel-xlsxxlsxopenpyxlsame as abovepyexcel-xlsxwxlsx(write only)XlsxWritersame as abovepyexcel-ods3odsezodf,
lxml2.6, 2.7, 3.3, 3.4
3.5, 3.6pyexcel-odsodsodfpysame as abovepyexcel-odsrods(read only)lxmlsame as abovepyexcel-text(write only)json, rst,
mediawiki, html,
latex, grid, pipe,
orgtbl, plain simpletabulate2.6, 2.7, 3.3, 3.4
3.5, 3.6, pypypyexcel-handsontablehandsontable in htmlhandsontablesame as abovepyexcel-pygalsvg chartpygal2.7, 3.3, 3.4, 3.5
3.6, pypypyexcel-sortablesortable table in htmlcsvtotablesame as aboveIn 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’).Footnotes[1]zipped csv file[2]zipped tsv fileInstallationYou can install it via pip:$pipinstallpyexcel-clior clone it and install it:$gitclonehttps://github.com/pyexcel/pyexcel-cli.git$cdpyexcel-cli$pythonsetup.pyinstallDevelopment guideDevelopment steps for code changesgit clonehttps://github.com/pyexcel/pyexcel-cli.gitcd pyexcel-cliUpgrade your setup tools and pip. They are needed for development and testing only:pip install –upgrade setuptools pipThen install relevant development requirements:pip install -r rnd_requirements.txt # if such a file existspip install -r requirements.txtpip install -r tests/requirements.txtOnce you have finished your changes, please provide test case(s), relevant documentation
and update CHANGELOG.rst.NoteAs to rnd_requirements.txt, usually, it is created when a dependentlibrary 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 contributionAlthoughnoseanddoctestare both used in code testing, it is adviable that unit tests are put in tests.doctestis 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:$ makeOn Windows systems, please issue this command:> test.batHow to update test environment and update documentationAdditional steps are required:pip install mobangit clonehttps://github.com/pyexcel/pyexcel-commons.gitcommonsmake your changes in.moban.ddirectory, then issue commandmobanWhat is pyexcel-commonsMany information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored inpyexcel-commonsproject.What is .moban.d.moban.dstores the specific meta data for the library.Acceptance criteriaHas Test cases writtenHas all code lines testedPasses all Travis CI buildsHas fair amount of documentation if your change is complexAgree on NEW BSD License for your contributionLicenseNew BSD LicenseChange log0.0.3 - 15.07.2017AddedTo allow viewing csvtotable in browser and the syntax is:
pyexcel view –in-browser –output-file-type sortable.html –sheet-index 0 goog.ods0.0.2 - 19.06.2017Updateduse pyexcel v0.5.00.0.1 - 11.07.2016Initial release