A wrapper library that provides one API to read, manipulate and write data in different excel formats
Project description
Known constraints
Fonts, colors and charts are not supported.
Feature Highlights
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.
Available Plugins
Package name |
Supported file formats |
Dependencies |
Python versions |
---|---|---|---|
2.6, 2.7, 3.3, 3.4, 3.5, pypy, pypy3 |
|||
xls, xlsx(read only), xlsm(read only) |
same as above |
||
xlsx |
same as above |
||
xlsx(write only) |
same as above |
||
ods |
ezodf, lxml |
2.6, 2.7, 3.3, 3.4 3.5 |
|
ods |
same as above |
||
(write only)json, rst, mediawiki, html, latex, grid, pipe, orgtbl, plain simple |
2.6, 2.7, 3.3, 3.4 3.5, pypy, pypy3 |
Footnotes
Installation
You can install it via pip:
$ pip install pyexcel
or clone it and install it:
$ git clone http://github.com/pyexcel/pyexcel.git
$ cd pyexcel
$ python setup.py install
Usage
>>> 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)
>>> os.unlink("myfile.xlsx")
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
Acknowledgement
All great work have done by odf, ezodf, xlrd, xlwt, tabulate and other individual developers. This library unites only the data access code.
Development guide
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
make your changes in .moban.d directory, then issue command moban
What is 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.
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.
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:
$ make test
On Windows systems, please issue this command:
> test.bat
License
New BSD License
Change log
0.3.2 - 05.11.2016
Updated
# 62: optional module import error become visible.
0.3.0 - 28.10.2016
Added:
file type setters for Sheet and Book, and its documentation
iget_records returns a generator for a list of records and should have better memory performance, especially dealing with large csv files.
iget_array returns a generator for a list of two dimensional array and should have better memory performance, especially dealing with large csv files.
Enable pagination support, and custom row renderer via pyexcel-io v0.2.3
Updated
Take isave_as out from save_as. Hence two functions are there for save a sheet as
# 60: encode ‘utf-8’ if the console is of ascii encoding.
# 59: custom row renderer
# 56: set cell value does not work
pyexcel.transpose becomes pyexcel.sheets.transpose
iterator functions of pyexcel.Sheet were converted to generator functions
pyexcel.Sheet.enumerate()
pyexcel.Sheet.reverse()
pyexcel.Sheet.vertical()
pyexcel.Sheet.rvertical()
pyexcel.Sheet.rows()
pyexcel.Sheet.rrows()
pyexcel.Sheet.columns()
pyexcel.Sheet.rcolumns()
pyexcel.Sheet.named_rows()
pyexcel.Sheet.named_columns()
~pyexcel.Sheet.save_to_memory and ~pyexcel.Book.save_to_memory return the actual content. No longer they will return a io object hence you cannot call getvalue() on them.
Removed:
content and out_file as function parameters to the signature functions are no longer supported.
SourceFactory and RendererFactory are removed
The following methods are removed
pyexcel.to_array
pyexcel.to_dict
pyexcel.utils.to_one_dimensional_array
pyexcel.dict_to_array
pyexcel.from_records
pyexcel.to_records
pyexcel.Sheet.filter has been re-implemented and all filters were removed:
pyexcel.filters.ColumnIndexFilter
pyexcel.filters.ColumnFilter
pyexcel.filters.RowFilter
pyexcel.filters.EvenColumnFilter
pyexcel.filters.OddColumnFilter
pyexcel.filters.EvenRowFilter
pyexcel.filters.OddRowFilter
pyexcel.filters.RowIndexFilter
pyexcel.filters.SingleColumnFilter
pyexcel.filters.RowValueFilter
pyexcel.filters.NamedRowValueFilter
pyexcel.filters.ColumnValueFilter
pyexcel.filters.NamedColumnValueFilter
pyexcel.filters.SingleRowFilter
the following functions have been removed
add_formatter
remove_formatter
clear_formatters
freeze_formatters
add_filter
remove_filter
clear_filters
freeze_formatters
pyexcel.Sheet.filter has been re-implemented and all filters were removed:
pyexcel.formatters.SheetFormatter
0.2.5 - 31.08.2016
Updated:
# 58: texttable should have been made as compulsory requirement
0.2.4 - 14.07.2016
Updated:
For python 2, writing to sys.stdout by pyexcel-cli raise IOError.
0.2.3 - 11.07.2016
Updated:
For python 3, do not seek 0 when saving to memory if sys.stdout is passed on. Hence, adding support for sys.stdin and sys.stdout.
0.2.2 - 01.06.2016
Updated:
Explicit imports, no longer needed
Depends on latest setuptools 18.0.1
NotImplementedError will be raised if parameters to core functions are not supported, e.g. get_sheet(cannot_find_me_option=”will be thrown out as NotImplementedError”)
0.2.1 - 23.04.2016
Added:
add pyexcel-text file types as attributes of pyexcel.Sheet and pyexcel.Book, related to issue 31
auto import pyexcel-text if it is pip installed
Updated:
code refactoring done for easy addition of sources.
bug fix issue 29, Even if the format is a string it is displayed as a float
pyexcel-text is no longer a plugin to pyexcel-io but to pyexcel.sources, see pyexcel-text issue #22
Removed:
pyexcel.presentation is removed. No longer the internal decorate @outsource is used. related to issue 31
0.2.0 - 17.01.2016
Updated
adopt pyexcel-io yield key word to return generator as content
pyexcel.save_as and pyexcel.save_book_as get performance improvements
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.