update documentation
This commit is contained in:
parent
634437958a
commit
1a519d8f93
|
@ -70,24 +70,12 @@ get_data(.., library='pyexcel-ods')
|
|||
.. _ods: https://github.com/pyexcel/pyexcel-ods
|
||||
.. _ods3: https://github.com/pyexcel/pyexcel-ods3
|
||||
|
||||
Special Note on PyInstaller
|
||||
********************************************************************************
|
||||
|
||||
When you packaging pyexcel-io with its plugins, please specify the plugins in
|
||||
its hidden import options::
|
||||
|
||||
--hidden-import pyexcel_[nick_name] --hidden-import pyexcel_[nick_name].[nick_name]
|
||||
|
||||
Nick name here refers to the second part of the package name. Suppose you
|
||||
wanted to package pyexcel-xls with pyexcel-io, the options to pyinstaller are::
|
||||
|
||||
--hidden-import pyexcel_xls --hidden-import pyexcel_xls.xls
|
||||
|
||||
.. toctree::
|
||||
:caption: Migration Note
|
||||
:maxdepth: 2
|
||||
|
||||
migration_from_dot_1_to_dot_2
|
||||
pyinstaller
|
||||
|
||||
.. toctree::
|
||||
:caption: Tutorial
|
||||
|
@ -106,6 +94,10 @@ wanted to package pyexcel-xls with pyexcel-io, the options to pyinstaller are::
|
|||
API
|
||||
--------------------------------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
common_parameters
|
||||
|
||||
.. currentmodule:: pyexcel_io
|
||||
|
||||
.. autosummary::
|
||||
|
|
|
@ -0,0 +1,19 @@
|
|||
Common parameters
|
||||
================================================================================
|
||||
|
||||
auto_dectect_datetime
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
The datetime formats are:
|
||||
|
||||
#. %Y-%m-%d
|
||||
#. %Y-%m-%d %H:%M:%S
|
||||
#. %Y-%m-%d %H:%M:%S.%f
|
||||
|
||||
Any other datetime formats will be thrown as ValueError
|
||||
|
||||
'library' option is added
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
In order to have overlapping plugins co-exit, 'library' option is added to
|
||||
get_data and save_data.
|
|
@ -1,37 +0,0 @@
|
|||
API changes from 0.1.0 to 0.2.0
|
||||
================================================================================
|
||||
|
||||
pyexcel-io version 0.2.0 is not 100% backward compatible and requires version
|
||||
0.2.0 of its plugins to function seamlessly. Here are the differences.
|
||||
|
||||
|
||||
get_data returns a dictionary of two dimensional array always
|
||||
---------------------------------------------------------------
|
||||
|
||||
Version 0.1.0 and elder, get_data returns a two dimensional array if there
|
||||
is only one sheet and returns a dictionary of two dimensional array otherwise.
|
||||
This behaviour has removed in 0.2.0
|
||||
|
||||
load_data is deprecated and should not be used
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
Version 0.1.0 and elder, load_data was used by pyexcel and maybe by others.
|
||||
Version 0.2.0 discourage you from using it as it will be removed at some point
|
||||
in the future.
|
||||
|
||||
auto_dectect_datetime
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
The datetime formats are:
|
||||
|
||||
#. %Y-%m-%d
|
||||
#. %Y-%m-%d %H:%M:%S
|
||||
#. %Y-%m-%d %H:%M:%S.%f
|
||||
|
||||
Any other datetime formats will be thrown as ValueError
|
||||
|
||||
'library' option is added
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
In order to have overlapping plugins co-exit, 'library' option is added to
|
||||
get_data and save_data.
|
|
@ -0,0 +1,78 @@
|
|||
Packaging with PyInstaller
|
||||
================================================================================
|
||||
|
||||
With pyexcel-io v0.4.0, the way to package it has been changed because it
|
||||
uses lml for all plugins.
|
||||
|
||||
Built-in plugins of pyexcel-io
|
||||
-------------------------------
|
||||
|
||||
In order to package every built-in plugins of pyexcel-io, you need to specify::
|
||||
|
||||
--hidden-import pyexcel_io.readers.csvr
|
||||
--hidden-import pyexcel_io.readers.csvz
|
||||
--hidden-import pyexcel_io.readers.tsv
|
||||
--hidden-import pyexcel_io.readers.tsvz
|
||||
--hidden-import pyexcel_io.writers.csvw
|
||||
--hidden-import pyexcel_io.readers.csvz
|
||||
--hidden-import pyexcel_io.readers.tsv
|
||||
--hidden-import pyexcel_io.readers.tsvz
|
||||
--hidden-import pyexcel_io.database.importers.django
|
||||
--hidden-import pyexcel_io.database.importers.sqlalchemy
|
||||
--hidden-import pyexcel_io.database.exporters.django
|
||||
--hidden-import pyexcel_io.database.exporters.sqlalchemy
|
||||
|
||||
pyexcel-xlsx
|
||||
----------------
|
||||
|
||||
In order to package pyexcel-xlsx, you need to specify::
|
||||
|
||||
--hidden-import pyexcel_xlsx
|
||||
--hidden-import pyexcel_xlsx.xlsxr
|
||||
--hidden-import pyexcel_xlsx.xlsxw
|
||||
|
||||
pyexcel-xlsxw
|
||||
----------------
|
||||
|
||||
In order to package pyexcel-xlsxw, you need to specify::
|
||||
|
||||
--hidden-import pyexcel_xlsxw
|
||||
--hidden-import pyexcel_xlsxw.xlsxw
|
||||
|
||||
pyexcel-xls
|
||||
----------------
|
||||
|
||||
In order to package pyexcel-xls, you need to specify::
|
||||
|
||||
--hidden-import pyexcel_xls
|
||||
--hidden-import pyexcel_xls.xlsr
|
||||
--hidden-import pyexcel_xls.xlsw
|
||||
|
||||
|
||||
pyexcel-ods
|
||||
----------------
|
||||
|
||||
In order to package pyexcel-ods, you need to specify::
|
||||
|
||||
--hidden-import pyexcel_ods
|
||||
--hidden-import pyexcel_ods.odsr
|
||||
--hidden-import pyexcel_ods.odsw
|
||||
|
||||
pyexcel-ods3
|
||||
----------------
|
||||
|
||||
In order to package pyexcel-ods3, you need to specify::
|
||||
|
||||
--hidden-import pyexcel_ods3
|
||||
--hidden-import pyexcel_ods3.odsr
|
||||
--hidden-import pyexcel_ods3.odsw
|
||||
|
||||
pyexcel-odsr
|
||||
----------------
|
||||
|
||||
In order to package pyexcel-odsr, you need to specify::
|
||||
|
||||
--hidden-import pyexcel_odsr
|
||||
--hidden-import pyexcel_ods4.odsr
|
||||
|
||||
|
Loading…
Reference in New Issue