If your company has embedded pyexcel and its components into a revenue generating product, please support me on github, patreon or bounty source 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.
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.
Fonts, colors and charts are not supported.
pyexcel-cli brings 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
$ cd demo
$ pyexcel view --in-browser --output-file-type sortable.html --sheet-index 0 https://github.com/pyexcel/excel2table/raw/master/sample/goog.odsHere's what you will get:
Note
You will need to install pyexcel-sortable, which renders it.
Here is another cli example usage:
$ 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.
| Package name | Supported file formats | Dependencies | Python versions |
|---|---|---|---|
| pyexcel-io | csv, csvz [1], tsv, tsvz [2] | 2.6, 2.7, 3.3, 3.4, 3.5, 3.6 pypy | |
| pyexcel-xls | xls, xlsx(read only), xlsm(read only) | xlrd, xlwt | same as above |
| pyexcel-xlsx | xlsx | openpyxl | same as above |
| pyexcel-ods3 | ods | pyexcel-ezodf, lxml | 2.6, 2.7, 3.3, 3.4 3.5, 3.6 |
| pyexcel-ods | ods | odfpy | same as above |
| 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. |
| Package name | Supported file formats | Dependencies | Python versions |
|---|---|---|---|
| pyexcel-text | write only:rst, mediawiki, html, latex, grid, pipe, orgtbl, plain simple read only: ndjson r/w: json | tabulate | 2.6, 2.7, 3.3, 3.4 3.5, 3.6, pypy |
| 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 |
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').
Footnotes
| [1] | zipped csv file |
| [2] | zipped tsv file |
You can install pyexcel-cli via pip:
$ pip install pyexcel-clior clone it and install it:
$ git clone https://github.com/pyexcel/pyexcel-cli.git
$ cd pyexcel-cli
$ python setup.py installDevelopment 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.
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
Additional steps are required:
- pip install moban
- make your changes in .moban.d directory, then issue command moban
Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in pyexcel-commons project.
.moban.d stores the specific meta data for the library.
New BSD License
