Package: pyramid-excel
================================================================================pyramid-excel - Let you focus on data, instead of file formats================================================================================.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png:target: https://www.patreon.com/pyexcel.. image:: https://api.travis-ci.org/pyexcel/pyramid-excel.svg?branch=master:target: http://travis-ci.org/pyexcel/pyramid-excel.. image:: https://codecov.io/gh/pyexcel/pyramid-excel/branch/master/graph/badge.svg:target: https://codecov.io/gh/pyexcel/pyramid-excel.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg:target: https://gitter.im/pyexcel/Lobby.. image:: https://readthedocs.org/projects/pyramid-excel/badge/?version=latest:target: http://pyramid-excel.readthedocs.org/en/latest/Support the project================================================================================If your company has embedded pyexcel and its components into a revenue generatingproduct, please `support me on patreon <https://www.patreon.com/bePatron?u=5537627>`_ tomaintain the project and develop it further.If you are an individual, you are welcome to support me too on patreon and for however longyou feel like to. As a patreon, you will receive`early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>`_.With your financial support, I will be able to investa little bit more time in coding, documentation and writing interesting posts.Known constraints==================Fonts, colors and charts are not supported.Introduction================================================================================Here is a typical conversation between the developer and the user::User: "I have uploaded an excel file""but your application says un-supported file format"Developer: "Did you upload an xlsx file or a csv file?"User: "Well, I am not sure. I saved the data using ""Microsoft Excel. Surely, it must be in an excel format."Developer: "OK. Here is the thing. I were not told to support""all available excel formats in day 1. Live with it""or delay the project x number of days."**pyramid-excel** is based on `pyexcel <https://github.com/pyexcel/pyexcel>`_ and makesit easy to consume/produce information stored in excel files over HTTP protocol aswell as on file system. This library can turn the excel data into a list of lists,a list of records(dictionaries), dictionaries of lists. And vice versa. Hence itlets you focus on data in Pyramid based web development, instead of file formats.The idea originated from the common usability problem when developing an excel filedriven web applications for non-technical office workers: such as office assistant,human resource administrator. The fact is that not all people know thedifference among various excel formats: csv, xls, xlsx. Instead of training those peopleabout file formats, this library helps web developers to handle most of the excel fileformats by providing a common programming interface. To add a specific excel file formatto you application, all you need is to install an extra pyexcel plugin. No code changeto your application. Looking at the community, this library and its associated ones tryto become a small and easy to install alternative to Pandas.The highlighted features are:#. excel data import into and export from databases#. turn uploaded excel file directly into Python data structure#. pass Python data structures as an excel file download#. provide data persistence as an excel file in server side#. supports csv, tsv, csvz, tsvz by default and other formats are supported viathe following plugins:.. _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,tsvz [#f2]_                             3.4, 3.5, 3.6pypy`pyexcel-xls`_           xls, xlsx(read only),   `xlrd`_,        same as abovexlsm(read only)         `xlwt`_`pyexcel-xlsx`_          xlsx                    `openpyxl`_     same as above`pyexcel-xlsxw`_         xlsx(write only)        `XlsxWriter`_   same as above`pyexcel-ods3`_          ods                     `ezodf`_,       2.6, 2.7, 3.3, 3.4lxml            3.5, 3.6`pyexcel-ods`_           ods                     `odfpy`_        same as above`pyexcel-odsr`_          ods(read only)          lxml            same as above`pyexcel-text`_          (write only)json, rst,  `tabulate`_     2.6, 2.7, 3.3, 3.4mediawiki, html,                        3.5, 3.6, pypylatex, grid, pipe,orgtbl, plain simple`pyexcel-handsontable`_  handsontable in html    `handsontable`_ same as above`pyexcel-pygal`_         svg chart               `pygal`_        2.7, 3.3, 3.4, 3.53.6, pypy`pyexcel-sortable`_      sortable table in html  `csvtotable`_   same as above`pyexcel-gantt`_         gantt chart in html     `frappe-gantt`_ except pypy, sameas above======================== ======================= =============== ==================.. _pyexcel-io: https://github.com/pyexcel/pyexcel-io.. _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-odsr: https://github.com/pyexcel/pyexcel-odsr.. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw.. _xlrd: https://github.com/python-excel/xlrd.. _xlwt: https://github.com/python-excel/xlwt.. _openpyxl: https://bitbucket.org/openpyxl/openpyxl.. _XlsxWriter: https://github.com/jmcnamara/XlsxWriter.. _ezodf: https://github.com/T0ha/ezodf.. _odfpy: https://github.com/eea/odfpy.. _pyexcel-text: https://github.com/pyexcel/pyexcel-text.. _tabulate: https://bitbucket.org/astanin/python-tabulate.. _pyexcel-handsontable: https://github.com/pyexcel/pyexcel-handsontable.. _handsontable: https://cdnjs.com/libraries/handsontable.. _pyexcel-pygal: https://github.com/pyexcel/pyexcel-chart.. _pygal: https://github.com/Kozea/pygal.. _pyexcel-matplotlib: https://github.com/pyexcel/pyexcel-matplotlib.. _matplotlib: https://matplotlib.org.. _pyexcel-sortable: https://github.com/pyexcel/pyexcel-sortable.. _csvtotable: https://github.com/vividvilla/csvtotable.. _pyexcel-gantt: https://github.com/pyexcel/pyexcel-gantt.. _frappe-gantt: https://github.com/frappe/ganttIn order to manage the list of plugins installed, you need to use pip to add or removea plugin. When you use virtualenv, you can have different plugins per virtualenvironment. In the situation where you have multiple plugins that does the same thingin your environment, you need to tell pyexcel which plugin to use per function call.For example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr.You need to append get_array(..., library='pyexcel-odsr')... rubric:: Footnotes.. [#f1] zipped csv file.. [#f2] zipped tsv fileThis library makes information processing involving various excel files as easy asprocessing array, dictionary when processing file upload/download, data import intoand export from SQL databases, information analysis and persistence. It uses**pyexcel** and its plugins:#. to provide one uniform programming interface to handle csv, tsv, xls, xlsx, xlsm and ods formats.#. to provide one-stop utility to import the data in uploaded file into a database and to export tables in a database as excel files for file download.#. to provide the same interface for information persistence at server side: saving a uploaded excel file to and loading a saved excel file from file system.Tested Pyramid Versions========================.. image:: https://img.shields.io/badge/pyramid-1.9-green.svg:target: http://travis-ci.org/pyexcel/pyramid-excel.. image:: https://img.shields.io/badge/pyramid-1.8.4-green.svg:target: http://travis-ci.org/pyexcel/pyramid-excel.. image:: https://img.shields.io/badge/pyramid-1.7.6-green.svg:target: http://travis-ci.org/pyexcel/pyramid-excel.. image:: https://img.shields.io/badge/pyramid-1.6.1-green.svg:target: http://travis-ci.org/pyexcel/pyramid-excel.. image:: https://img.shields.io/badge/pyramid-1.5.8-green.svg:target: http://travis-ci.org/pyexcel/pyramid-excel.. image:: https://img.shields.io/badge/pyramid-1.4.9-green.svg:target: http://travis-ci.org/pyexcel/pyramid-excelInstallation================================================================================You can install it via pip:.. code-block:: bash$ pip install pyramid-excelor clone it and install it:.. code-block:: bash$ git clone https://github.com/pyexcel/pyramid-excel.git$ cd pyramid-excel$ python setup.py installSetup======Once the pyramid_excel is installed, you must use the config.include mechanism to includeit into your Pyramid project's configuration::config = Configurator(.....)config.include('pyramid_excel')Alternately, you may activate the extension by changing your application's .ini file byadding it to the pyramid.includes list::pyramid.includes = pyramid_excelDevelopment guide================================================================================Development steps for code changes#. git clone https://github.com/pyexcel/pyramid-excel.git#. cd pyramid-excelUpgrade your setup tools and pip. They are needed for development and testing only:#. pip install --upgrade setuptools pipThen install relevant development requirements:#. pip install -r rnd_requirements.txt # if such a file exists#. pip install -r requirements.txt#. pip install -r tests/requirements.txtOnce you have finished your changes, please provide test case(s), relevant documentationand update CHANGELOG.rst... note::As to rnd_requirements.txt, usually, it is created when a dependentlibrary is not released. Once the dependecy is installed(will be released), the futureversion of the dependency in the requirements.txt will be valid.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::$ makeOn Windows systems, please issue this command::> test.batHow to update test environment and update documentation---------------------------------------------------------Additional steps are required:#. pip install moban#. git clone https://github.com/pyexcel/pyexcel-commons.git commons#. make your changes in `.moban.d` directory, then issue command `moban`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.Acceptance criteria-------------------#. Has Test cases written#. Has all code lines tested#. Passes all Travis CI builds#. Has fair amount of documentation if your change is complex#. Agree on NEW BSD License for your contributionLicense================================================================================New BSD LicenseChange log================================================================================0.0.5 - 20.07.2017--------------------------------------------------------------------------------Updated********************************************************************************#. adapt pyexcel-webio 0.1.2 which brings iget_records, iget_array,isave_to_database and isave_book_to_database.0.0.4 - 29.06.2017--------------------------------------------------------------------------------Added********************************************************************************#. `issue 3 <https://github.com/pyexcel/django-excel/issues/3>`_, Supportunicode code as download file name0.0.3 - 16.03.2016--------------------------------------------------------------------------------Updated++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++#. update dependencies on pyramid>=1.4.9, pyexcel-webio>=0.0.6#. use moban to separate common texts from package specific info