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
Plugins |
Supported file formats |
---|---|
csv, csvz, tsv, tsvz |
|
xls, xlsx(r), xlsm(r) |
|
xlsx |
|
ods (python 2.6, 2.7 only) |
|
ods |
|
(write only)json, rst, mediawiki,latex, grid, pipe, orgtbl, plain simple |
Installation
Recently, pyexcel(0.2.2+) and its plugins(0.2.0+) started using newer version of setuptools. Please upgrade your setup tools before install latest pyexcel components:
$ pip install --upgrade setuptools
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
Installation of individual plugins , please refer to individual plugin page.
Usage
JSON
>>> import pyexcel as pe
>>> an_array = [[1,2]]
>>> sheet = pe.Sheet(an_array)
>>> sheet.json
'{"pyexcel sheet": [[1, 2]]}'
Note: It is available with pyexcel v0.2.1 and pyexcel-text 0.2.0
TSV
>>> sheet.tsv
'1\t2\r\n'
Note: TSV and the rest of the formats are available with pyexcel v0.2.2 and its plugins at version 0.2.0+ only
CSV
>>> sheet.csv
'1,2\r\n'
Documentation
Documentation is hosted at read the docs and pyhosted
Development guide
Development steps for code changes
git clone https://github.com/pyexcel/pyexcel.git
cd pyexcel
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 envrionment, 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 depdent 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
Acknowledgement
All great work have done by odf, ezodf(2), xlrd, xlwt, tabulate and other individual developers. This library unites only the data access code.
Change log
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 refactored sources 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 imporvements
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.