Package: django-excel
Support the projectIf your company has embedded pyexcel and its components into a revenue generating
product, pleasesupport me on patreonto
maintain the project and develop it further.If you are an individual, you are welcome to support me too on patreon and for however long
you feel like. As a patreon, you will receiveearly access to pyexcel related contents.And your issues will get prioritized if you would like to become my patreon aspyexcel pro user.With your financial support, I will be able to invest
a little bit more time in coding, documentation and writing interesting posts.Known constraintsFonts, colors and charts are not supported.IntroductionHere 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."django-excelis based onpyexceland makes
it easy to consume/produce information stored in excel files over HTTP protocol as
well 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 it
lets you focus on data in Django based web development, instead of file formats.The idea originated from the common usability problem: when an excel file
driven web application is delivered for non-developer users (ie: team assistant,
human resource administrator etc). The fact is that not everyone knows (or cares) about the
differences between various excel formats: csv, xls, xlsx are all the same to them. Instead of training those users
about file formats, this library helps web developers to handle most of the excel file
formats by providing a common programming interface. To add a specific excel file format type
to you application, all you need is to install an extra pyexcel plugin. Hence no code changes
to your application and no issues with excel file formats any more. Looking at the
community, this library and its associated ones try to become a small and easy to
install alternative to Pandas.The highlighted features are:excel data import into and export from databasesturn uploaded excel file directly into Python data structurepass Python data structures as an excel file downloadprovide data persistence as an excel file in server sidesupports csv, tsv, csvz, tsvz by default and other formats are supported via
the following plugins:A list of file formats supported by external pluginsPackage nameSupported file formatsDependenciesPython versionspyexcel-iocsv, csvz[1], tsv,
tsvz[2]2.6, 2.7, 3.3,
3.4, 3.5, 3.6
pypypyexcel-xlsxls, xlsx(read only),
xlsm(read only)xlrd,xlwtsame as abovepyexcel-xlsxxlsxopenpyxlsame as abovepyexcel-ods3odspyexcel-ezodf,
lxml2.6, 2.7, 3.3, 3.4
3.5, 3.6pyexcel-odsodsodfpysame as aboveDedicated file reader and writersPackage nameSupported file formatsDependenciesPython versionspyexcel-xlsxwxlsx(write only)XlsxWriterPython 2 and 3pyexcel-xlsxrxlsx(read only)lxmlsame as abovepyexcel-odsrread only for ods, fodslxmlsame as abovepyexcel-htmlrhtml(read only)lxml,html5libsame as aboveOther data renderersPackage nameSupported file formatsDependenciesPython versionspyexcel-textwrite only:rst,
mediawiki, html,
latex, grid, pipe,
orgtbl, plain simple
read only: ndjson
r/w: jsontabulate2.6, 2.7, 3.3, 3.4
3.5, 3.6, pypypyexcel-handsontablehandsontable in htmlhandsontablesame as abovepyexcel-pygalsvg chartpygal2.7, 3.3, 3.4, 3.5
3.6, pypypyexcel-sortablesortable table in htmlcsvtotablesame as abovepyexcel-ganttgantt chart in htmlfrappe-ganttexcept pypy, same
as aboveIn order to manage the list of plugins installed, you need to use pip to add or remove
a plugin. When you use virtualenv, you can have different plugins per virtual
environment. In the situation where you have multiple plugins that does the same thing
in 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’).Footnotes[1]zipped csv file[2]zipped tsv fileThis library makes information processing involving various excel files as easy as
processing array, dictionary when processing file upload/download, data import into
and export from SQL databases, information analysis and persistence. It usespyexceland 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 Django VersionsTest on django 2.0.1 fails.InstallationYou can install django-excel via pip:$pipinstalldjango-excelor clone it and install it:$gitclonehttps://github.com/pyexcel-webwares/django-excel.git$cddjango-excel$pythonsetup.pyinstallSetupYou will need to update yoursettings.py:FILE_UPLOAD_HANDLERS=("django_excel.ExcelMemoryFileUploadHandler","django_excel.TemporaryExcelFileUploadHandler")UsageHere is the example viewing function codes:fromdjango.shortcutsimportrender_to_responsefromdjango.httpimportHttpResponseBadRequestfromdjangoimportformsfromdjango.templateimportRequestContextimportdjango_excelasexcelclassUploadFileForm(forms.Form):file=forms.FileField()defupload(request):ifrequest.method=="POST":form=UploadFileForm(request.POST,request.FILES)ifform.is_valid():filehandle=request.FILES['file']returnexcel.make_response(filehandle.get_sheet(),"csv")else:returnHttpResponseBadRequest()else:form=UploadFileForm()returnrender_to_response('upload_form.html',{'form':form},context_instance=RequestContext(request))defdownload(request):sheet=excel.pe.Sheet([[1,2],[3,4]])returnexcel.make_response(sheet,"csv")Development guideDevelopment steps for code changesgit clonehttps://github.com/pyexcel/django-excel.gitcd django-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 existspip install -r requirements.txtpip install -r tests/requirements.txtOnce you have finished your changes, please provide test case(s), relevant documentation
and update CHANGELOG.rst.NoteAs to rnd_requirements.txt, usually, it is created when a dependent
library is not released. Once the dependecy is installed
(will be released), the future
version of the dependency in the requirements.txt will be valid.How to test your contributionAlthoughnoseanddoctestare both used in code testing, it is adviable that unit tests are put in tests.doctestis 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 documentationAdditional steps are required:pip install mobangit clonehttps://github.com/moremoban/setupmobans.git# generic setupgit clonehttps://github.com/pyexcel/pyexcel-commons.gitcommonsmake your changes in.moban.ddirectory, then issue commandmobanWhat is pyexcel-commonsMany information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored inpyexcel-commonsproject.What is .moban.d.moban.dstores the specific meta data for the library.Acceptance criteriaHas Test cases writtenHas all code lines testedPasses all Travis CI buildsHas fair amount of documentation if your change is complexPlease update CHANGELOG.rstPlease add yourself to CONTRIBUTORS.rstAgree on NEW BSD License for your contributionLicenseNew BSD LicenseChange log0.0.10 - 11.01.2018Addedpyexcel-io#46, exposebulk_saveto django developers0.0.9 - 12.07.2017Addedbring isave_to_database and isave_book_to_database0.0.8 - 07.07.2017Addedpyexcel#39, explicitly
seeking at 00.0.7 - 29.06.2017Addedpyexcel#38, Support
unicode code as download file name0.0.6 - 12.22.2016Updatedpyexcel#26, raise ioerror
if content is empty.Use pyexcel-webio v0.0.9 so as to push out new version of pyexcel and its
plugins.0.0.5 - 26.08.2016Added:Support for django 1.6.xTested against django 1.10