121 lines
4.0 KiB
Plaintext
121 lines
4.0 KiB
Plaintext
.. pyexcel_io documentation master file, created by
|
|
sphinx-quickstart on Fri May 08 09:33:05 2015.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
{%include "header.rst.jj2" %}
|
|
|
|
Introduction
|
|
--------------------------------------------------------------------------------
|
|
|
|
**pyexcel-io** provides **one** application programming interface(API) to read
|
|
and write data in different excel formats. It makes information processing
|
|
involving excel files a simple task. The data in excel files can be turned into
|
|
an ordered dictionary with least code. This library focuses on data processing
|
|
using excel files as storage media hence fonts, colors and charts were not and
|
|
will not be considered.
|
|
|
|
It was created due to the lack of uniform programming interface to access data
|
|
in different excel formats. A developer needs to use different methods of
|
|
different libraries to read the same data in different excel formats, hence
|
|
the resulting code is cluttered and unmaintainable. This is a challenge posed
|
|
by users who do not know or care about the differences in excel file formats.
|
|
Instead of educating the users about the specific excel format a data processing
|
|
application supports, the library takes up the challenge and promises to support
|
|
all known excel formats.
|
|
|
|
All great work have done by individual library developers. This library unites
|
|
only the data access API. With that said, **pyexcel-io** also bring something
|
|
new on the table: :ref:`"csvz" and "tsvz"<csvz>` format, new format names
|
|
as of 2014. They are invented and supported by `pyexcel-io`_.
|
|
|
|
|
|
Installation
|
|
--------------------------------------------------------------------------------
|
|
|
|
{%include "installation.rst.jj2" %}
|
|
|
|
For individual excel file formats, please install them as you wish:
|
|
|
|
{%include "io-plugins-list.rst.jj2" %}
|
|
|
|
After that, you can start get and save data in the loaded format. There
|
|
are two plugins for the same file format, e.g. pyexcel-ods3 and pyexcel-ods.
|
|
If you want to choose one, please try pip uninstall the un-wanted one. And if
|
|
you want to have both installed but wanted to use one of them for a function
|
|
call(or file type) and the other for another function call(or file type), you can
|
|
pass on "library" option to get_data and save_data, e.g.
|
|
get_data(.., library='pyexcel-ods')
|
|
|
|
|
|
.. note::
|
|
pyexcel-text is no longer a plugin of pyexcel-io but a direct plugin of pyexcel
|
|
|
|
|
|
.. table:: Plugin compatibility table
|
|
|
|
============= ======= ======== ======= ======== ======== ========
|
|
`pyexcel-io`_ `xls`_ `xlsx`_ `ods`_ `ods3`_ `odsr`_ `xlsxw`_
|
|
============= ======= ======== ======= ======== ======== ========
|
|
0.5.10+ 0.5.0+ 0.5.0+ 0.5.4 0.5.3 0.5.0+ 0.5.0+
|
|
0.5.1+ 0.5.0+ 0.5.0+ 0.5.0+ 0.5.0+ 0.5.0+ 0.5.0+
|
|
0.4.x 0.4.x 0.4.x 0.4.x 0.4.x 0.4.x 0.4.x
|
|
0.3.0+ 0.3.0+ 0.3.0 0.3.0+ 0.3.0+ 0.3.0 0.3.0
|
|
0.2.2+ 0.2.2+ 0.2.2+ 0.2.1+ 0.2.1+ 0.0.1
|
|
0.2.0+ 0.2.0+ 0.2.0+ 0.2.0 0.2.0 0.0.1
|
|
============= ======= ======== ======= ======== ======== ========
|
|
|
|
.. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
|
|
.. _xls: https://github.com/pyexcel/pyexcel-xls
|
|
.. _xlsx: https://github.com/pyexcel/pyexcel-xlsx
|
|
.. _xlsxw: https://github.com/pyexcel/pyexcel-xlsxw
|
|
.. _odsr: https://github.com/pyexcel/pyexcel-odsr
|
|
.. _ods: https://github.com/pyexcel/pyexcel-ods
|
|
.. _ods3: https://github.com/pyexcel/pyexcel-ods3
|
|
|
|
|
|
.. toctree::
|
|
:caption: Migration Note
|
|
:maxdepth: 2
|
|
|
|
pyinstaller
|
|
|
|
.. toctree::
|
|
:caption: Tutorial
|
|
:maxdepth: 2
|
|
|
|
plaincsv
|
|
pagination
|
|
renderer
|
|
extendedcsv
|
|
csvz
|
|
sqlalchemy
|
|
django
|
|
options
|
|
extensions
|
|
|
|
|
|
API
|
|
--------------------------------------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
common_parameters
|
|
|
|
.. currentmodule:: pyexcel_io
|
|
|
|
.. autosummary::
|
|
:toctree: api/
|
|
|
|
get_data
|
|
save_data
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|