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 [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-xlsxw | xlsx(write only) | XlsxWriter | same as above |
| pyexcel-ods3 | ods | ezodf, lxml | 2.6, 2.7, 3.3, 3.4 3.5, 3.6 |
| pyexcel-ods | ods | odfpy | same as above |
| pyexcel-odsr | ods(read only) | lxml | 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 |
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 it 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 installIf your company has embedded pyexcel and its components into a revenue generating product, please support me on patreon to 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 receive early 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.
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.
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
- git clone https://github.com/pyexcel/pyexcel-commons.git commons
- 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.
- Has Test cases written
- Has all code lines tested
- Passes all Travis CI builds
- Has fair amount of documentation if your change is complex
- Agree on NEW BSD License for your contribution
New BSD License