A python library to read and write structured data in csv, zipped csvformat and to/from databases
Support the project
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-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||Python versions|
|pyexcel-io||csv, csvz , tsv, tsvz ||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-odsr||read only for ods, fods||lxml||same as above|
|pyexcel-htmlr||html(read only)||lxml,html5lib||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’).
|||zipped csv file|
|||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-io
or clone it and install it:
$ git clone https://github.com/pyexcel/pyexcel-io.git $ cd pyexcel-io $ python setup.py install
Development 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.rst.
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:
On Windows systems, please issue this command:
How to update test environment and update documentation
Additional steps are required:
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.
- Has Test cases written
- Has all code lines tested
- Passes all Travis CI builds
- Has fair amount of documentation if your change is complex
- Please update CHANGELOG.rst
- Please add yourself to CONTRIBUTORS.rst
- Agree on NEW BSD License for your contribution
New BSD License
0.5.6 - 11.01.2018
- #46, expose bulk_save to developer
0.5.5 - 23.12.2017
- Issue #45, csv reader throws exception because google app engine does not support mmap. People who are not working with google app engine, need not to take this update. Enjoy your Christmas break.
0.5.4 - 10.11.2017
- PR #44, use unicodewriter for csvz writers.
0.5.3 - 23.10.2017
- pyexcel pyexcel#105, remove gease from setup_requires, introduced by 0.5.2.
- remove python2.6 test support
0.5.2 - 20.10.2017
- pyexcel#103, include LICENSE file in MANIFEST.in, meaning LICENSE file will appear in the released tar ball.
0.5.1 - 02.09.2017
- pyexcel-ods#25, Unwanted dependency on pyexcel.
0.5.0 - 30.08.2017
- Collect all data type conversion codes as service.py.
- #19, use cString by default. For python, it will be a performance boost
0.4.4 - 08.08.2017
- #42, raise exception if database table name does not match the sheet name
0.4.3 - 29.07.2017
- #41, walk away gracefully when mmap is not available.
0.4.2 - 05.07.2017
- #37, permanently fix the residue folder pyexcel by release all future releases in a clean clone.
0.4.1 - 29.06.2017
- #39, raise exception when bulk save in django fails. Please bulk_save=False if you as the developer choose to save the records one by one if bulk_save cannot be used. However, exception in one-by-one save case will be raised as well. This change is made to raise exception in the first place so that you as the developer will be suprised when it was deployed in production.
0.4.0 - 19.06.2017
- ‘built-in’ as the value to the parameter ‘library’ as parameter to invoke pyexcel-io’s built-in csv, tsv, csvz, tsvz, django and sql won’t work. It is renamed to ‘pyexcel-io’.
- built-in csv, tsv, csvz, tsvz, django and sql are lazy loaded.
- pyexcel-io plugin interface has been updated. v0.3.x plugins won’t work.
- #32, csv and csvz file handle are made sure to be closed. File close mechanism is enfored.
- iget_data function is introduced to cope with dangling file handle issue.
- Removed plugin loading code and lml is used instead
0.3.4 - 18.05.2017
- #33, handle mmap object differently given as file content. This issue has put in a priority to single sheet csv over multiple sheets in a single memory stream. The latter format is pyexcel own creation but is rarely used. In latter case, multiple_sheet=True should be passed along get_data.
- #34, treat mmap object as a file content.
- #35, encoding parameter take no effect when given along with file content
- use ZIP_DEFALTED to really do the compression
0.3.3 - 30.03.2017
- #31, support pyinstaller
0.3.2 - 26.01.2017
- #29, change skip_empty_rows to False by default
0.3.1 - 21.01.2017
- updated versions of extra packages
- #23, provide helpful message when old pyexcel plugin exists
- restored previously available diagnosis message for missing libraries
0.3.0 - 22.12.2016
- lazy loading of plugins. for example, pyexcel-xls is not entirely loaded until xls format is used at its first attempted reading or writing. Since it is loaded, it will not be loaded in the second io action.
- pyexcel-xls#11, make case-insensitive for file type
0.2.6 - 21.12.2016
- #24, pass on batch_size
0.2.5 - 20.12.2016
- #26, performance issue with getting the number of columns.
0.2.4 - 24.11.2016
- #23, Failed to convert long integer string in python 2 to its actual value
0.2.3 - 16.09.2016
0.2.2 - 31.08.2016
- support pagination. two pairs: start_row, row_limit and start_column, column_limit help you deal with large files.
- skip_empty_rows=True was introduced. To include empty rows, put it to False.
- #20, pyexcel-io attempts to parse cell contents of ‘infinity’ as a float/int, crashes
0.2.1 - 11.07.2016
- csv format: handle utf-16 encoded csv files. Potentially being able to decode other formats if correct “encoding” is provided
- csv format: write utf-16 encoded files. Potentially other encoding is also supported
- support stdin as input stream and stdout as output stream
- Attention, user of pyexcel-io! No longer io stream validation is performed in python 3. The guideline is: io.StringIO for csv, tsv only, otherwise BytesIO for xlsx, xls, ods. You can use RWManager.get_io to produce a correct stream type for you.
- #15, support foreign django/sql foreign key
0.2.0 - 01.06.2016
- autoload of pyexcel-io plugins
- auto detect datetime, float and int. Detection can be switched off by auto_detect_datetime, auto_detect_float, auto_detect_int
0.1.0 - 17.01.2016
- yield key word to return generator as content
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|pyexcel_io-0.5.7-py2.py3-none-any.whl (36.4 kB) Copy SHA256 hash SHA256||Wheel||3.6||May 2, 2018|
|pyexcel-io-0.5.7.tar.gz (37.1 kB) Copy SHA256 hash SHA256||Source||None||May 2, 2018|