update doc
This commit is contained in:
chfw
parent
a295fea4bc
commit
68e0640ea2
|
|
@ -8,19 +8,7 @@ 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:
|
||||
|
||||
================ ==================================
|
||||
Plugins Supported file formats
|
||||
================ ==================================
|
||||
`pyexcel-xls`_ xls, xlsx(r), xlsm(r)
|
||||
`pyexcel-xlsx`_ xlsx
|
||||
`pyexcel-ods3`_ ods
|
||||
`pyexcel-ods`_ ods (python 2.6, 2.7 only)
|
||||
================ ==================================
|
||||
|
||||
.. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls
|
||||
.. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx
|
||||
.. _pyexcel-ods: https://github.com/pyexcel/pyexcel-ods
|
||||
.. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3
|
||||
{% include "io-plugins-list.rst.jj2" %}
|
||||
|
||||
If you need to manipulate the data, you might do it yourself or use its brother
|
||||
library `pyexcel <https://github.com/pyexcel/pyexcel>`__ .
|
||||
|
|
|
|||
|
|
@ -0,0 +1,110 @@
|
|||
.. 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.
|
||||
|
||||
.. table:: Plugin compatibility table
|
||||
|
||||
============= ======= ======== ======= ======== ========
|
||||
`pyexcel-io`_ `xls`_ `xlsx`_ `ods`_ `ods3`_ `xlsxw`_
|
||||
============= ======= ======== ======= ======== ========
|
||||
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
|
||||
.. _xlsx: https://github.com/pyexcel/pyexcel-xlsxw
|
||||
.. _ods: https://github.com/pyexcel/pyexcel-ods
|
||||
.. _ods3: https://github.com/pyexcel/pyexcel-ods3
|
||||
.. _text: https://github.com/pyexcel/pyexcel-text
|
||||
|
||||
.. note::
|
||||
pyexcel-text is no longer a plugin of pyexcel-io but a direct plugin of pyexcel
|
||||
|
||||
Special note
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
migration_from_dot_1_to_dot_2
|
||||
|
||||
|
||||
Tutorial
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
plaincsv
|
||||
pagination
|
||||
extendedcsv
|
||||
csvz
|
||||
sqlalchemy
|
||||
django
|
||||
extensions
|
||||
|
||||
|
||||
API
|
||||
--------------------------------------------------
|
||||
|
||||
.. currentmodule:: pyexcel_io
|
||||
|
||||
.. autosummary::
|
||||
:toctree: api/
|
||||
|
||||
get_data
|
||||
save_data
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
|
@ -14,4 +14,5 @@ targets:
|
|||
- MANIFEST.in: MANIFEST.in.jj2
|
||||
- test.sh: test.sh.jj2
|
||||
- test.bat: test.sh.jj2
|
||||
- README.rst: README.rst
|
||||
- README.rst: README.rst
|
||||
- "doc/source/index.rst": "docs/source/index.rst"
|
||||
34
README.rst
34
README.rst
|
|
@ -18,19 +18,37 @@ 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:
|
||||
|
||||
================ ==================================
|
||||
Plugins Supported file formats
|
||||
================ ==================================
|
||||
`pyexcel-xls`_ xls, xlsx(r), xlsm(r)
|
||||
`pyexcel-xlsx`_ xlsx
|
||||
`pyexcel-ods3`_ ods
|
||||
`pyexcel-ods`_ ods (python 2.6, 2.7 only)
|
||||
================ ==================================
|
||||
.. _file-format-list:
|
||||
.. _a-map-of-plugins-and-file-formats:
|
||||
|
||||
.. table:: A list of file formats supported by external plugins
|
||||
|
||||
================= ======================= ============= ==================
|
||||
Package name Supported file formats Dependencies Python versions
|
||||
================= ======================= ============= ==================
|
||||
`pyexcel-io`_ csv, csvz [#f1]_, tsv, 2.6, 2.7, 3.3,
|
||||
3.4, pypy, pypy3
|
||||
tsvz [#f2]_
|
||||
`pyexcel-xls`_ xls, xlsx(read only), xlrd, xlwt 2.6, 2.7, 3.3,
|
||||
3.4, pypy, pypy3
|
||||
xlsm(read only)
|
||||
`pyexcel-xlsx`_ xlsx openpyxl 2.6, 2.7, 3.3,
|
||||
3.4, pypy, pypy3
|
||||
`pyexcel-xlsxw`_ xlsx(write only) xlsxwriter 2.6, 2.7, 3.3,
|
||||
3.4, pypy, pypy3
|
||||
`pyexcel-ods3`_ ods ezodf, lxml 2.6, 2.7, 3.3, 3.4
|
||||
`pyexcel-ods`_ ods (python 2.6, 2.7) odfpy 2.6, 2.7
|
||||
================= ======================= ============= ==================
|
||||
|
||||
.. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls
|
||||
.. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx
|
||||
.. _pyexcel-ods: https://github.com/pyexcel/pyexcel-ods
|
||||
.. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3
|
||||
.. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw
|
||||
.. rubric:: Footnotes
|
||||
|
||||
.. [#f1] zipped csv file
|
||||
.. [#f2] zipped tsv file
|
||||
|
||||
If you need to manipulate the data, you might do it yourself or use its brother
|
||||
library `pyexcel <https://github.com/pyexcel/pyexcel>`__ .
|
||||
|
|
|
|||
|
|
@ -6,9 +6,8 @@
|
|||
`pyexcel-io` - Let you focus on data, instead of file formats
|
||||
================================================================================
|
||||
|
||||
|
||||
:Author: C.W.
|
||||
:Source code: http://github.com/pyexcel/pyexcel-io
|
||||
:Source code: http://github.com/pyexcel/pyexcel-io.git
|
||||
:Issues: http://github.com/pyexcel/pyexcel-io/issues
|
||||
:License: New BSD License
|
||||
:Development: |release|
|
||||
|
|
@ -39,39 +38,58 @@ 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`_.
|
||||
|
||||
Getting the source
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
Source code is hosted in github. You can get it using git client::
|
||||
|
||||
$ git clone http://github.com/pyexcel/pyexcel-io.git
|
||||
|
||||
Installation
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
You can install it via pip::
|
||||
You can install it via pip:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ pip install pyexcel-io
|
||||
|
||||
|
||||
or clone it and install it:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ git clone http://github.com/pyexcel/pyexcel-io.git
|
||||
$ cd pyexcel-io
|
||||
$ python setup.py install
|
||||
|
||||
For individual excel file formats, please install them as you wish:
|
||||
|
||||
.. _file-format-list:
|
||||
.. _a-map-of-plugins-and-file-formats:
|
||||
.. table:: a map of plugins and supported excel file formats
|
||||
|
||||
============== ======================= ============= ==================
|
||||
Package name Supported file formats Dependencies Python versions
|
||||
============== ======================= ============= ==================
|
||||
`pyexcel-io`_ csv, csvz [#f1]_, tsv, 2.6, 2.7, 3.3,
|
||||
3.4, pypy, pypy3
|
||||
tsvz [#f2]_
|
||||
`xls`_ xls, xlsx(read only), xlrd, xlwt 2.6, 2.7, 3.3,
|
||||
3.4, pypy, pypy3
|
||||
xlsm(read only)
|
||||
`xlsx`_ xlsx openpyxl 2.6, 2.7, 3.3,
|
||||
3.4, pypy, pypy3
|
||||
`ods3`_ ods ezodf, lxml 2.6, 2.7, 3.3, 3.4
|
||||
`ods`_ ods (python 2.6, 2.7) odfpy 2.6, 2.7
|
||||
============== ======================= ============= ==================
|
||||
.. table:: A list of file formats supported by external plugins
|
||||
|
||||
================= ======================= ============= ==================
|
||||
Package name Supported file formats Dependencies Python versions
|
||||
================= ======================= ============= ==================
|
||||
`pyexcel-io`_ csv, csvz [#f1]_, tsv, 2.6, 2.7, 3.3,
|
||||
3.4, pypy, pypy3
|
||||
tsvz [#f2]_
|
||||
`pyexcel-xls`_ xls, xlsx(read only), xlrd, xlwt 2.6, 2.7, 3.3,
|
||||
3.4, pypy, pypy3
|
||||
xlsm(read only)
|
||||
`pyexcel-xlsx`_ xlsx openpyxl 2.6, 2.7, 3.3,
|
||||
3.4, pypy, pypy3
|
||||
`pyexcel-xlsxw`_ xlsx(write only) xlsxwriter 2.6, 2.7, 3.3,
|
||||
3.4, pypy, pypy3
|
||||
`pyexcel-ods3`_ ods ezodf, lxml 2.6, 2.7, 3.3, 3.4
|
||||
`pyexcel-ods`_ ods (python 2.6, 2.7) odfpy 2.6, 2.7
|
||||
================= ======================= ============= ==================
|
||||
|
||||
.. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls
|
||||
.. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx
|
||||
.. _pyexcel-ods: https://github.com/pyexcel/pyexcel-ods
|
||||
.. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3
|
||||
.. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw
|
||||
.. rubric:: Footnotes
|
||||
|
||||
.. [#f1] zipped csv file
|
||||
.. [#f2] zipped tsv file
|
||||
|
||||
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.
|
||||
|
|
@ -142,9 +160,3 @@ Indices and tables
|
|||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
||||
.. rubric:: Footnotes
|
||||
|
||||
.. [#f1] zipped csv file
|
||||
.. [#f2] zipped tsv file
|
||||
|
|
|
|||
Loading…
Reference in New Issue