Skip to content

Commit

Permalink
🤝 update project meta data
Browse files Browse the repository at this point in the history
  • Loading branch information
@chfw
chfw committed Oct 16, 2020
1 parent 6b8e4f3 commit 0eb8df6
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 59 deletions.
4 changes: 2 additions & 2 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2015-2019 by Onni Software Ltd. and its contributors
Copyright (c) 2015-2020 by Onni Software Ltd. and its contributors
All rights reserved.

Redistribution and use in source and binary forms of the software as well
Expand All @@ -13,7 +13,7 @@ that the following conditions are met:
and/or other materials provided with the distribution.

* Neither the name of 'pyramid-excel' nor the names of the contributors
may be used to endorse or promote products derived from this software
may not be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND
Expand Down
64 changes: 37 additions & 27 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ pyramid-excel - Let you focus on data, instead of file formats
.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
:target: https://gitter.im/pyexcel/Lobby

.. image:: https://img.shields.io/static/v1?label=continuous%20templating&message=%E6%A8%A1%E7%89%88%E6%9B%B4%E6%96%B0&color=blue&style=flat-square
:target: https://moban.readthedocs.io/en/latest/#at-scale-continous-templating-for-open-source-projects

.. image:: https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square
:target: https://github.com/psf/black
.. image:: https://readthedocs.org/projects/pyramid-excel/badge/?version=latest
:target: http://pyramid-excel.readthedocs.org/en/latest/

Expand Down Expand Up @@ -97,44 +102,47 @@ The highlighted features are:

.. table:: A list of file formats supported by external plugins

======================== ======================= ================= ==================
Package name Supported file formats Dependencies Python versions
======================== ======================= ================= ==================
`pyexcel-io`_ >=v0.6.0 csv, csvz [#f1]_, tsv, 3.6+
tsvz [#f2]_
`pyexcel-io`_ <=0.5.20 same as above 2.6, 2.7, 3.3,
3.4, 3.5, 3.6
pypy
`pyexcel-xls`_ xls, xlsx(read only), `xlrd`_, same as above
======================== ======================= =================
Package name Supported file formats Dependencies
======================== ======================= =================
`pyexcel-io`_ csv, csvz [#f1]_, tsv,
tsvz [#f2]_
`pyexcel-xls`_ xls, xlsx(read only), `xlrd`_,
xlsm(read only) `xlwt`_
`pyexcel-xlsx`_ xlsx `openpyxl`_ same as above
`pyexcel-ods3`_ ods `pyexcel-ezodf`_, 2.6, 2.7, 3.3, 3.4
lxml 3.5, 3.6
`pyexcel-ods`_ ods `odfpy`_ same as above
======================== ======================= ================= ==================
`pyexcel-xlsx`_ xlsx `openpyxl`_
`pyexcel-ods3`_ ods `pyexcel-ezodf`_,
lxml
`pyexcel-ods`_ ods `odfpy`_
======================== ======================= =================

.. table:: Dedicated file reader and writers

======================== ======================= ================= ==================
Package name Supported file formats Dependencies Python versions
======================== ======================= ================= ==================
`pyexcel-xlsxw`_ xlsx(write only) `XlsxWriter`_ Python 2 and 3
`pyexcel-xlsxr`_ xlsx(read only) lxml same as above
`pyexcel-xlsbr`_ xlsx(read only) pyxlsb same as above
`pyexcel-odsr`_ read only for ods, fods lxml same as above
`pyexcel-odsw`_ write only for ods loxun same as above
`pyexcel-htmlr`_ html(read only) lxml,html5lib same as above
`pyexcel-pdfr`_ pdf(read only) pdftables Python 2 only.
======================== ======================= ================= ==================
======================== ======================= =================
Package name Supported file formats Dependencies
======================== ======================= =================
`pyexcel-xlsxw`_ xlsx(write only) `XlsxWriter`_
`pyexcel-libxlsxw`_ xlsx(write only) `libxlsxwriter`_
`pyexcel-xlsxr`_ xlsx(read only) lxml
`pyexcel-xlsbr`_ xlsb(read only) pyxlsb
`pyexcel-odsr`_ read only for ods, fods lxml
`pyexcel-odsw`_ write only for ods loxun
`pyexcel-htmlr`_ html(read only) lxml,html5lib
`pyexcel-pdfr`_ pdf(read only) camelot
======================== ======================= =================


Plugin shopping guide
------------------------

Since 2020, all pyexcel-io plugins have dropped the support for python version
lower than 3.6. If you want to use any python verions, please use pyexcel-io
and its plugins version lower than 0.6.0.


Except csv files, xls, xlsx and ods files are a zip of a folder containing a lot of
xml files
xml files

The dedicated readers for excel files can stream read
The dedicated readers for excel files can stream read


In order to manage the list of plugins installed, you need to use pip to add or remove
Expand All @@ -156,6 +164,7 @@ You need to append get_array(..., library='pyexcel-odsr').
.. _pyexcel-pdfr: https://github.com/pyexcel/pyexcel-pdfr

.. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw
.. _pyexcel-libxlsxw: https://github.com/pyexcel/pyexcel-libxlsxw
.. _pyexcel-xlsxr: https://github.com/pyexcel/pyexcel-xlsxr
.. _pyexcel-xlsbr: https://github.com/pyexcel/pyexcel-xlsbr
.. _pyexcel-htmlr: https://github.com/pyexcel/pyexcel-htmlr
Expand All @@ -166,6 +175,7 @@ You need to append get_array(..., library='pyexcel-odsr').
.. _XlsxWriter: https://github.com/jmcnamara/XlsxWriter
.. _pyexcel-ezodf: https://github.com/pyexcel/pyexcel-ezodf
.. _odfpy: https://github.com/eea/odfpy
.. _libxlsxwriter: http://libxlsxwriter.github.io/getting_started.html

.. table:: Other data renderers

Expand Down
59 changes: 32 additions & 27 deletions docs/source/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,44 +57,47 @@ The highlighted features are:

.. table:: A list of file formats supported by external plugins

======================== ======================= ================= ==================
Package name Supported file formats Dependencies Python versions
======================== ======================= ================= ==================
`pyexcel-io`_ >=v0.6.0 csv, csvz [#f1]_, tsv, 3.6+
tsvz [#f2]_
`pyexcel-io`_ <=0.5.20 same as above 2.6, 2.7, 3.3,
3.4, 3.5, 3.6
pypy
`pyexcel-xls`_ xls, xlsx(read only), `xlrd`_, same as above
======================== ======================= =================
Package name Supported file formats Dependencies
======================== ======================= =================
`pyexcel-io`_ csv, csvz [#f1]_, tsv,
tsvz [#f2]_
`pyexcel-xls`_ xls, xlsx(read only), `xlrd`_,
xlsm(read only) `xlwt`_
`pyexcel-xlsx`_ xlsx `openpyxl`_ same as above
`pyexcel-ods3`_ ods `pyexcel-ezodf`_, 2.6, 2.7, 3.3, 3.4
lxml 3.5, 3.6
`pyexcel-ods`_ ods `odfpy`_ same as above
======================== ======================= ================= ==================
`pyexcel-xlsx`_ xlsx `openpyxl`_
`pyexcel-ods3`_ ods `pyexcel-ezodf`_,
lxml
`pyexcel-ods`_ ods `odfpy`_
======================== ======================= =================

.. table:: Dedicated file reader and writers

======================== ======================= ================= ==================
Package name Supported file formats Dependencies Python versions
======================== ======================= ================= ==================
`pyexcel-xlsxw`_ xlsx(write only) `XlsxWriter`_ Python 2 and 3
`pyexcel-xlsxr`_ xlsx(read only) lxml same as above
`pyexcel-xlsbr`_ xlsx(read only) pyxlsb same as above
`pyexcel-odsr`_ read only for ods, fods lxml same as above
`pyexcel-odsw`_ write only for ods loxun same as above
`pyexcel-htmlr`_ html(read only) lxml,html5lib same as above
`pyexcel-pdfr`_ pdf(read only) pdftables Python 2 only.
======================== ======================= ================= ==================
======================== ======================= =================
Package name Supported file formats Dependencies
======================== ======================= =================
`pyexcel-xlsxw`_ xlsx(write only) `XlsxWriter`_
`pyexcel-libxlsxw`_ xlsx(write only) `libxlsxwriter`_
`pyexcel-xlsxr`_ xlsx(read only) lxml
`pyexcel-xlsbr`_ xlsb(read only) pyxlsb
`pyexcel-odsr`_ read only for ods, fods lxml
`pyexcel-odsw`_ write only for ods loxun
`pyexcel-htmlr`_ html(read only) lxml,html5lib
`pyexcel-pdfr`_ pdf(read only) camelot
======================== ======================= =================


Plugin shopping guide
------------------------

Since 2020, all pyexcel-io plugins have dropped the support for python version
lower than 3.6. If you want to use any python verions, please use pyexcel-io
and its plugins version lower than 0.6.0.


Except csv files, xls, xlsx and ods files are a zip of a folder containing a lot of
xml files
xml files

The dedicated readers for excel files can stream read
The dedicated readers for excel files can stream read


In order to manage the list of plugins installed, you need to use pip to add or remove
Expand All @@ -116,6 +119,7 @@ You need to append get_array(..., library='pyexcel-odsr').
.. _pyexcel-pdfr: https://github.com/pyexcel/pyexcel-pdfr

.. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw
.. _pyexcel-libxlsxw: https://github.com/pyexcel/pyexcel-libxlsxw
.. _pyexcel-xlsxr: https://github.com/pyexcel/pyexcel-xlsxr
.. _pyexcel-xlsbr: https://github.com/pyexcel/pyexcel-xlsbr
.. _pyexcel-htmlr: https://github.com/pyexcel/pyexcel-htmlr
Expand All @@ -126,6 +130,7 @@ You need to append get_array(..., library='pyexcel-odsr').
.. _XlsxWriter: https://github.com/jmcnamara/XlsxWriter
.. _pyexcel-ezodf: https://github.com/pyexcel/pyexcel-ezodf
.. _odfpy: https://github.com/eea/odfpy
.. _libxlsxwriter: http://libxlsxwriter.github.io/getting_started.html

.. table:: Other data renderers

Expand Down
2 changes: 1 addition & 1 deletion lint.sh
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
pip install flake8
flake8 --exclude=.moban.d,docs,setup.py --ignore=F401,E402 --builtins=unicode,xrange,long . && python setup.py checkdocs
flake8 --exclude=.moban.d,docs,setup.py --ignore=F401,E402 --builtins=unicode,xrange,long . && python setup.py checkdocs
4 changes: 2 additions & 2 deletions setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,14 @@
}
# You do not need to read beyond this line
PUBLISH_COMMAND = "{0} setup.py sdist bdist_wheel upload -r pypi".format(sys.executable)
HERE = os.path.abspath(os.path.dirname(__file__))

GS_COMMAND = ("gs pyramid-excel v0.0.5 " +
"Find 0.0.5 in changelog for more details")
NO_GS_MESSAGE = ("Automatic github release is disabled. " +
"Please install gease to enable it.")
UPLOAD_FAILED_MSG = (
'Upload failed. please run "%s" yourself.' % PUBLISH_COMMAND)
HERE = os.path.abspath(os.path.dirname(__file__))


class PublishCommand(Command):
Expand Down Expand Up @@ -146,7 +147,6 @@ def run(self):
"publish": PublishCommand
})


def has_gease():
"""
test if github release command is installed
Expand Down

0 comments on commit 0eb8df6

Please sign in to comment.