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.
Nor to read password protected xls, xlsx and ods files.
pyexcel-io provides one application programming interface(API) to read and write the data in excel format, import the data into and export the data from database. It provides support for csv(z) format, django database and sqlalchemy supported databases. Its supported file formats are extended to cover "xls", "xlsx", "ods" by the following extensions:
| Package name | Supported file formats | Dependencies |
|---|---|---|
| pyexcel-io | csv, csvz [1], tsv, tsvz [2] | |
| pyexcel-xls | xls, xlsx(read only), xlsm(read only) | xlrd, xlwt |
| pyexcel-xlsx | xlsx | openpyxl |
| pyexcel-ods3 | ods | pyexcel-ezodf, lxml |
| pyexcel-ods | ods | odfpy |
| Package name | Supported file formats | Dependencies |
|---|---|---|
| pyexcel-xlsxw | xlsx(write only) | XlsxWriter |
| pyexcel-libxlsxw | xlsx(write only) | libxlsxwriter |
| pyexcel-xlsxr | xlsx(read only) | lxml |
| pyexcel-xlsbr | xlsb(read only) | pyxlsb |
| pyexcel-odsr | read only for ods, fods | lxml |
| pyexcel-odsw | write only for ods | loxun |
| pyexcel-htmlr | html(read only) | lxml,html5lib |
| pyexcel-pdfr | pdf(read only) | camelot |
Since 2020, all pyexcel-io plugins have dropped the support for python versions which are lower than 3.6. If you want to use any of those Python versions, please use pyexcel-io and its plugins versions that are lower than 0.6.0.
Except csv files, xls, xlsx and ods files are a zip of a folder containing a lot of xml files
The dedicated readers for excel files can stream read
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 |
If you need to manipulate the data, you might do it yourself or use its brother library pyexcel .
If you would like to extend it, you may use it to write your own extension to handle a specific file format.
You can install pyexcel-io via pip:
$ pip install pyexcel-ioor clone it and install it:
$ git clone https://github.com/pyexcel/pyexcel-io.git
$ cd pyexcel-io
$ python setup.py installDevelopment steps for code changes
- git clone https://github.com/pyexcel/pyexcel-io.git
- cd pyexcel-io
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.yml
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, please issue this command:
> test.bat
Please run:
$ make format
so as to beautify your code otherwise your build may fail your unit test.
New BSD License
