Fonts, colors and charts are not supported.
- One API to handle multiple data sources:
- physical file
- memory file
- SQLAlchemy table
- Django Model
- Python data stuctures: dictionary, records and array
- One application programming interface(API) to read and write data in various excel file formats.
| 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, pypy, pypy3 | |
| 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 |
| pyexcel-ods | ods | odfpy | same as above |
| pyexcel-text | (write only)json, rst, mediawiki, html, latex, grid, pipe, orgtbl, plain simple | tabulate | 2.6, 2.7, 3.3, 3.4 3.5, pypy, pypy3 |
Footnotes
| [1] | zipped csv file |
| [2] | zipped tsv file |
You can install it via pip:
$ pip install pyexcelor clone it and install it:
$ git clone http://github.com/pyexcel/pyexcel.git
$ cd pyexcel
$ python setup.py install>>> import pyexcel
>>> content = "1,2,3\n3,4,5"
>>> sheet = pyexcel.Sheet()
>>> sheet.csv = content
>>> sheet.array
[[1, 2, 3], [3, 4, 5]]
>>> with open("myfile.xlsx", "wb") as output:
... write_count_not_used = output.write(sheet.xlsx).. testcode::
:hide:
>>> import os
>>> os.unlink("myfile.xlsx")
.. testcode::
:hide:
>>> import pyexcel
>>> # make sure you had pyexcel-xls pip-installed
>>> a_list_of_dictionaries = [
... {
... "Name": 'Adam',
... "Age": 28
... },
... {
... "Name": 'Beatrice',
... "Age": 29
... },
... {
... "Name": 'Ceri',
... "Age": 30
... },
... {
... "Name": 'Dean',
... "Age": 26
... }
... ]
>>> pyexcel.save_as(records=a_list_of_dictionaries, dest_file_name="your_file.xls")
Suppose you want to process the following excel data :
| Name | Age |
|---|---|
| Adam | 28 |
| Beatrice | 29 |
| Ceri | 30 |
| Dean | 26 |
Here are the new method to obtain the records on demand:
>>> import pyexcel as pe
>>> records = pe.iget_records(file_name="your_file.xls")
>>> for record in records:
... print("%s is aged at %d" % (record['Name'], record['Age']))
Adam is aged at 28
Beatrice is aged at 29
Ceri is aged at 30
Dean is aged at 26.. testcode::
:hide:
>>> import os
>>> os.unlink("your_file.xls")
All great work have done by odf, ezodf, xlrd, xlwt, tabulate and other individual developers. This library unites only the data access code.
Development steps for code changes
- git clone https://github.com/pyexcel/pyexcel.git
- cd pyexcel
Upgrade your setup tools and pip. They are needed for development and testing only:
- pip install --upgrade setuptools "pip==7.1"
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
In order to update test environment, and documentation, additional setps are required:
- pip install moban
- git clone https://github.com/pyexcel/pyexcel-commons.git
- make your changes in .moban.d directory, then issue command moban
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.
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.
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 test
On Windows systems, please issue this command:
> test.bat
New BSD License