================================================================================
django-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/chfw
.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel-mobans/master/images/awesome-badge.svg
:target: https://awesome-python.com/#specific-formats-processing
.. image:: https://codecov.io/gh/pyexcel-webwares/django-excel/branch/master/graph/badge.svg
:target: https://codecov.io/gh/pyexcel-webwares/django-excel
.. image:: https://badge.fury.io/py/django-excel.svg
:target: https://pypi.org/project/django-excel
.. image:: https://pepy.tech/badge/django-excel/month
:target: https://pepy.tech/project/django-excel
.. 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/django-excel/badge/?version=latest
:target: http://django-excel.readthedocs.org/en/latest/
Support the project
================================================================================
If your company uses pyexcel and its components in a revenue-generating product,
please consider supporting the project on GitHub or
`Patreon <https://www.patreon.com/bePatron?u=5537627>`_. Your financial
support will enable me to dedicate more time to coding, improving documentation,
and creating engaging content.
Known constraints
==================
Fonts, colors and charts are not supported.
Nor to read password protected xls, xlsx and ods files.
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."
**django-excel** is based on `pyexcel <https://github.com/pyexcel/pyexcel>`_ and 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 behind pyexcel originated from a common usability problem: when Excel-driven
web applications are delivered to non-developer users (e.g., project assistants, human
resources administrators), they often are not aware of the differences
between file formats such as CSV, XLS, and XLSX. Rather than training users on these
formats, pyexcel provides web developers with a unified interface to handle most
Excel file types.
To add support for a specific Excel format in your application, simply install an
additional pyexcel plugin—no code changes required. This eliminates issues with
different file formats. In the broader community, pyexcel and its associated
libraries aim to be a simple, easy-to-install alternative to Pandas, where minimal
data manipulation is needed.
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 via
the 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
======================== ======================= =================
`pyexcel-io`_ csv, csvz [#f1]_, tsv, csvz,tsvz readers depends on `chardet`
tsvz [#f2]_
`pyexcel-xls`_ xls, xlsx(read only), `xlrd`_,
xlsm(read only) `xlwt`_
`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
======================== ======================= =================
`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 versions
which are lower than 3.6. If you want to use any of those Python versions, please use pyexcel-io
and its plugins versions that are 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
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
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').
.. _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-odsw: https://github.com/pyexcel/pyexcel-odsw
.. _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
.. _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
.. _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
======================== ======================= ================= ==================
Package name Supported file formats Dependencies Python versions
======================== ======================= ================= ==================
`pyexcel-text`_ write only:rst, `tabulate`_ 2.6, 2.7, 3.3, 3.4
mediawiki, html, 3.5, 3.6, pypy
latex, grid, pipe,
orgtbl, plain simple
read only: ndjson
r/w: json
`pyexcel-handsontable`_ handsontable in html `handsontable`_ same as above
`pyexcel-pygal`_ svg chart `pygal`_ 2.7, 3.3, 3.4, 3.5
3.6, pypy
`pyexcel-sortable`_ sortable table in html `csvtotable`_ same as above
`pyexcel-gantt`_ gantt chart in html `frappe-gantt`_ except pypy, same
as above
======================== ======================= ================= ==================
.. _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/gantt
.. rubric:: Footnotes
.. [#f1] zipped csv file
.. [#f2] zipped tsv file
This 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 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 Django Versions
========================
.. image:: https://img.shields.io/badge/django-3.1.2-green.svg
:target: http://travis-ci.org/pyexcel/django-excel
.. image:: https://img.shields.io/badge/django-2.1-green.svg
:target: http://travis-ci.org/pyexcel/django-excel
.. image:: https://img.shields.io/badge/django-2.0.8-green.svg
:target: http://travis-ci.org/pyexcel/django-excel
.. image:: https://img.shields.io/badge/django-1.11.15-green.svg
:target: http://travis-ci.org/pyexcel/django-excel
.. image:: https://img.shields.io/badge/django-1.10.8-green.svg
:target: http://travis-ci.org/pyexcel/django-excel
.. image:: https://img.shields.io/badge/django-1.9.13-green.svg
:target: http://travis-ci.org/pyexcel/django-excel
.. image:: https://img.shields.io/badge/django-1.8.18-green.svg
:target: http://travis-ci.org/pyexcel/django-excel
Installation
================================================================================
You can install django-excel via pip:
.. code-block:: bash
$ pip install django-excel
or clone it and install it:
.. code-block:: bash
$ git clone https://github.com/pyexcel-webwares/django-excel.git
$ cd django-excel
$ python setup.py install
Setup
======
You will need to update your *settings.py*:
.. code-block:: python
FILE_UPLOAD_HANDLERS = ("django_excel.ExcelMemoryFileUploadHandler",
"django_excel.TemporaryExcelFileUploadHandler")
Usage
=========
Here is the example viewing function codes:
.. code-block:: python
from django.shortcuts import render_to_response
from django.http import HttpResponseBadRequest
from django import forms
from django.template import RequestContext
import django_excel as excel
class UploadFileForm(forms.Form):
file = forms.FileField()
def upload(request):
if request.method == "POST":
form = UploadFileForm(request.POST, request.FILES)
if form.is_valid():
filehandle = request.FILES['file']
return excel.make_response(filehandle.get_sheet(), "csv")
else:
return HttpResponseBadRequest()
else:
form = UploadFileForm()
return render_to_response('upload_form.html',
{'form': form},
context_instance=RequestContext(request))
def download(request):
sheet = excel.pe.Sheet([[1, 2],[3, 4]])
return excel.make_response(sheet, "csv")
Development guide
================================================================================
Development steps for code changes
#. git clone https://github.com/pyexcel/django-excel.git
#. cd django-excel
Upgrade your setup tools and pip. They are needed for development and testing only:
#. pip install --upgrade setuptools pip
Then 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.txt
Once you have finished your changes, please provide test case(s), relevant documentation
and update changelog.yml
.. note::
As to rnd_requirements.txt, usually, it is created when a dependent
library is not released. Once the dependency is installed
(will be released), the future
version 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 advisable
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::
$ make
On Windows, please issue this command::
> test.bat
Before you commit
------------------------------
Please run::
$ make format
so as to beautify your code otherwise your build may fail your unit test.
License
================================================================================
New BSD License
5 contributors
================================================================================
In alphabetical order:
* `Andrei Lozhkin <https://github.com/lozhkinandrei>`_
* `Minh-Long Do <https://github.com/minhlongdo>`_
* `oon arfiandwi <https://github.com/oonid>`_
* `Utpal Brahma <https://github.com/thebrahma>`_
* `김상엽 <https://github.com/yeop-sang>`_
Change log
================================================================================
0.0.13 - 31.10.2025
--------------------------------------------------------------------------------
**Change:**
#. Replace pkg_resources-based Django version check with django.get_version()
#. Exclude .venv from flake8 check to simplify development
0.0.12 - not released
--------------------------------------------------------------------------------
**Change:**
#. Support for django 2.0.x
#. Tested against django 4.1
#. Change xlrd version <=1.2.0
0.0.11 - not released
--------------------------------------------------------------------------------
**Updated**
#. Test Support for django 3.x.x
#. Tested against django 3.x.x
0.0.10 - 11.01.2018
--------------------------------------------------------------------------------
**Added**
#. `pyexcel-io#46 <https://github.com/pyexcel-webwares/pyexcel-io/issues/46>`_,
expose `bulk_save` to django developers
0.0.9 - 12.07.2017
--------------------------------------------------------------------------------
**Added**
#. bring isave_to_database and isave_book_to_database
0.0.8 - 07.07.2017
--------------------------------------------------------------------------------
**Added**
#. `pyexcel#39 <https://github.com/pyexcel-webwares/pyexcel/issues/39>`_,
explicitly seeking at 0
0.0.7 - 29.06.2017
--------------------------------------------------------------------------------
**Added**
#. `pyexcel#38 <https://github.com/pyexcel-webwares/pyexcel/issues/38>`_,
Support unicode code as download file name
0.0.6 - 12.22.2016
--------------------------------------------------------------------------------
**Updated**
#. `pyexcel#26 <https://github.com/pyexcel-webwares/pyexcel/issues/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.2016
--------------------------------------------------------------------------------
**Added:**
#. Support for django 1.6.x
#. Tested against django 1.10
Raw data
{
"_id": null,
"home_page": "https://github.com/pyexcel-webwares/django-excel",
"name": "django-excel",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, API, Django",
"author": "C.W.",
"author_email": "info@pyexcel.org",
"download_url": "https://files.pythonhosted.org/packages/f9/57/5588d9b1ea284fc63a390988782049c5e5f15e3ceb74f8c511a321e1ddb5/django_excel-0.0.13.tar.gz",
"platform": null,
"description": "================================================================================\ndjango-excel - Let you focus on data, instead of file formats\n================================================================================\n\n.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png\n :target: https://www.patreon.com/chfw\n\n.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel-mobans/master/images/awesome-badge.svg\n :target: https://awesome-python.com/#specific-formats-processing\n\n.. image:: https://codecov.io/gh/pyexcel-webwares/django-excel/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/pyexcel-webwares/django-excel\n\n.. image:: https://badge.fury.io/py/django-excel.svg\n :target: https://pypi.org/project/django-excel\n\n\n\n.. image:: https://pepy.tech/badge/django-excel/month\n :target: https://pepy.tech/project/django-excel\n\n\n.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg\n :target: https://gitter.im/pyexcel/Lobby\n\n.. 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\n :target: https://moban.readthedocs.io/en/latest/#at-scale-continous-templating-for-open-source-projects\n\n.. image:: https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square\n :target: https://github.com/psf/black\n.. image:: https://readthedocs.org/projects/django-excel/badge/?version=latest\n :target: http://django-excel.readthedocs.org/en/latest/\n\nSupport the project\n================================================================================\n\nIf your company uses pyexcel and its components in a revenue-generating product,\nplease consider supporting the project on GitHub or\n`Patreon <https://www.patreon.com/bePatron?u=5537627>`_. Your financial\nsupport will enable me to dedicate more time to coding, improving documentation,\nand creating engaging content.\n\n\nKnown constraints\n==================\n\nFonts, colors and charts are not supported.\n\nNor to read password protected xls, xlsx and ods files.\n\nIntroduction\n================================================================================\nHere is a typical conversation between the developer and the user::\n\n User: \"I have uploaded an excel file\"\n \"but your application says un-supported file format\"\n Developer: \"Did you upload an xlsx file or a csv file?\"\n User: \"Well, I am not sure. I saved the data using \"\n \"Microsoft Excel. Surely, it must be in an excel format.\"\n Developer: \"OK. Here is the thing. I were not told to support\"\n \"all available excel formats in day 1. Live with it\"\n \"or delay the project x number of days.\"\n\n**django-excel** is based on `pyexcel <https://github.com/pyexcel/pyexcel>`_ and makes\nit easy to consume/produce information stored in excel files over HTTP protocol as\nwell as on file system. This library can turn the excel data into a list of lists,\na list of records(dictionaries), dictionaries of lists. And vice versa. Hence it\nlets you focus on data in Django based web development, instead of file formats.\n\nThe idea behind pyexcel originated from a common usability problem: when Excel-driven\nweb applications are delivered to non-developer users (e.g., project assistants, human\nresources administrators), they often are not aware of the differences\nbetween file formats such as CSV, XLS, and XLSX. Rather than training users on these\nformats, pyexcel provides web developers with a unified interface to handle most\nExcel file types.\n\n\nTo add support for a specific Excel format in your application, simply install an\nadditional pyexcel plugin\u2014no code changes required. This eliminates issues with\ndifferent file formats. In the broader community, pyexcel and its associated\nlibraries aim to be a simple, easy-to-install alternative to Pandas, where minimal\ndata manipulation is needed.\n\nThe highlighted features are:\n\n#. excel data import into and export from databases\n#. turn uploaded excel file directly into Python data structure\n#. pass Python data structures as an excel file download\n#. provide data persistence as an excel file in server side\n#. supports csv, tsv, csvz, tsvz by default and other formats are supported via\n the following plugins:\n\n.. _file-format-list:\n.. _a-map-of-plugins-and-file-formats:\n\n.. table:: A list of file formats supported by external plugins\n\n ======================== ======================= =================\n Package name Supported file formats Dependencies\n ======================== ======================= =================\n `pyexcel-io`_ csv, csvz [#f1]_, tsv, csvz,tsvz readers depends on `chardet`\n tsvz [#f2]_\n `pyexcel-xls`_ xls, xlsx(read only), `xlrd`_,\n xlsm(read only) `xlwt`_\n `pyexcel-xlsx`_ xlsx `openpyxl`_\n `pyexcel-ods3`_ ods `pyexcel-ezodf`_,\n lxml\n `pyexcel-ods`_ ods `odfpy`_\n ======================== ======================= =================\n\n.. table:: Dedicated file reader and writers\n\n ======================== ======================= =================\n Package name Supported file formats Dependencies\n ======================== ======================= =================\n `pyexcel-xlsxw`_ xlsx(write only) `XlsxWriter`_\n `pyexcel-libxlsxw`_ xlsx(write only) `libxlsxwriter`_\n `pyexcel-xlsxr`_ xlsx(read only) lxml\n `pyexcel-xlsbr`_ xlsb(read only) pyxlsb\n `pyexcel-odsr`_ read only for ods, fods lxml\n `pyexcel-odsw`_ write only for ods loxun\n `pyexcel-htmlr`_ html(read only) lxml,html5lib\n `pyexcel-pdfr`_ pdf(read only) camelot\n ======================== ======================= =================\n\n\nPlugin shopping guide\n------------------------\n\nSince 2020, all pyexcel-io plugins have dropped the support for python versions\nwhich are lower than 3.6. If you want to use any of those Python versions, please use pyexcel-io\nand its plugins versions that are lower than 0.6.0.\n\n\nExcept csv files, xls, xlsx and ods files are a zip of a folder containing a lot of\nxml files\n\nThe dedicated readers for excel files can stream read\n\n\nIn order to manage the list of plugins installed, you need to use pip to add or remove\na plugin. When you use virtualenv, you can have different plugins per virtual\nenvironment. In the situation where you have multiple plugins that does the same thing\nin your environment, you need to tell pyexcel which plugin to use per function call.\nFor example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr.\nYou need to append get_array(..., library='pyexcel-odsr').\n\n\n\n.. _pyexcel-io: https://github.com/pyexcel/pyexcel-io\n.. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls\n.. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx\n.. _pyexcel-ods: https://github.com/pyexcel/pyexcel-ods\n.. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3\n.. _pyexcel-odsr: https://github.com/pyexcel/pyexcel-odsr\n.. _pyexcel-odsw: https://github.com/pyexcel/pyexcel-odsw\n.. _pyexcel-pdfr: https://github.com/pyexcel/pyexcel-pdfr\n\n.. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw\n.. _pyexcel-libxlsxw: https://github.com/pyexcel/pyexcel-libxlsxw\n.. _pyexcel-xlsxr: https://github.com/pyexcel/pyexcel-xlsxr\n.. _pyexcel-xlsbr: https://github.com/pyexcel/pyexcel-xlsbr\n.. _pyexcel-htmlr: https://github.com/pyexcel/pyexcel-htmlr\n\n.. _xlrd: https://github.com/python-excel/xlrd\n.. _xlwt: https://github.com/python-excel/xlwt\n.. _openpyxl: https://bitbucket.org/openpyxl/openpyxl\n.. _XlsxWriter: https://github.com/jmcnamara/XlsxWriter\n.. _pyexcel-ezodf: https://github.com/pyexcel/pyexcel-ezodf\n.. _odfpy: https://github.com/eea/odfpy\n.. _libxlsxwriter: http://libxlsxwriter.github.io/getting_started.html\n\n.. table:: Other data renderers\n\n ======================== ======================= ================= ==================\n Package name Supported file formats Dependencies Python versions\n ======================== ======================= ================= ==================\n `pyexcel-text`_ write only:rst, `tabulate`_ 2.6, 2.7, 3.3, 3.4\n mediawiki, html, 3.5, 3.6, pypy\n latex, grid, pipe,\n orgtbl, plain simple\n read only: ndjson\n r/w: json\n `pyexcel-handsontable`_ handsontable in html `handsontable`_ same as above\n `pyexcel-pygal`_ svg chart `pygal`_ 2.7, 3.3, 3.4, 3.5\n 3.6, pypy\n `pyexcel-sortable`_ sortable table in html `csvtotable`_ same as above\n `pyexcel-gantt`_ gantt chart in html `frappe-gantt`_ except pypy, same\n as above\n ======================== ======================= ================= ==================\n\n.. _pyexcel-text: https://github.com/pyexcel/pyexcel-text\n.. _tabulate: https://bitbucket.org/astanin/python-tabulate\n.. _pyexcel-handsontable: https://github.com/pyexcel/pyexcel-handsontable\n.. _handsontable: https://cdnjs.com/libraries/handsontable\n.. _pyexcel-pygal: https://github.com/pyexcel/pyexcel-chart\n.. _pygal: https://github.com/Kozea/pygal\n.. _pyexcel-matplotlib: https://github.com/pyexcel/pyexcel-matplotlib\n.. _matplotlib: https://matplotlib.org\n.. _pyexcel-sortable: https://github.com/pyexcel/pyexcel-sortable\n.. _csvtotable: https://github.com/vividvilla/csvtotable\n.. _pyexcel-gantt: https://github.com/pyexcel/pyexcel-gantt\n.. _frappe-gantt: https://github.com/frappe/gantt\n\n.. rubric:: Footnotes\n\n.. [#f1] zipped csv file\n.. [#f2] zipped tsv file\n\n\nThis library makes information processing involving various excel files as easy as\nprocessing array, dictionary when processing file upload/download, data import into\nand export from SQL databases, information analysis and persistence. It uses\n**pyexcel** and its plugins:\n\n#. to provide one uniform programming interface to handle csv, tsv, xls, xlsx, xlsm and ods formats.\n#. 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.\n#. 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.\n\n\n\nTested Django Versions\n========================\n\n.. image:: https://img.shields.io/badge/django-3.1.2-green.svg\n :target: http://travis-ci.org/pyexcel/django-excel\n\n.. image:: https://img.shields.io/badge/django-2.1-green.svg\n :target: http://travis-ci.org/pyexcel/django-excel\n\n.. image:: https://img.shields.io/badge/django-2.0.8-green.svg\n :target: http://travis-ci.org/pyexcel/django-excel\n\n.. image:: https://img.shields.io/badge/django-1.11.15-green.svg\n :target: http://travis-ci.org/pyexcel/django-excel\n\n.. image:: https://img.shields.io/badge/django-1.10.8-green.svg\n :target: http://travis-ci.org/pyexcel/django-excel\n\n.. image:: https://img.shields.io/badge/django-1.9.13-green.svg\n :target: http://travis-ci.org/pyexcel/django-excel\n\n.. image:: https://img.shields.io/badge/django-1.8.18-green.svg\n :target: http://travis-ci.org/pyexcel/django-excel\n\nInstallation\n================================================================================\n\nYou can install django-excel via pip:\n\n.. code-block:: bash\n\n $ pip install django-excel\n\n\nor clone it and install it:\n\n.. code-block:: bash\n\n $ git clone https://github.com/pyexcel-webwares/django-excel.git\n $ cd django-excel\n $ python setup.py install\n\nSetup\n======\n\nYou will need to update your *settings.py*:\n\n.. code-block:: python\n\n FILE_UPLOAD_HANDLERS = (\"django_excel.ExcelMemoryFileUploadHandler\",\n \"django_excel.TemporaryExcelFileUploadHandler\")\n\n\n\nUsage\n=========\nHere is the example viewing function codes:\n\n.. code-block:: python\n\n from django.shortcuts import render_to_response\n from django.http import HttpResponseBadRequest\n from django import forms\n from django.template import RequestContext\n import django_excel as excel\n \n class UploadFileForm(forms.Form):\n file = forms.FileField()\n \n def upload(request):\n if request.method == \"POST\":\n form = UploadFileForm(request.POST, request.FILES)\n if form.is_valid():\n filehandle = request.FILES['file']\n return excel.make_response(filehandle.get_sheet(), \"csv\")\n else:\n return HttpResponseBadRequest()\n else:\n form = UploadFileForm()\n return render_to_response('upload_form.html',\n {'form': form},\n context_instance=RequestContext(request))\n \n def download(request):\n sheet = excel.pe.Sheet([[1, 2],[3, 4]])\n return excel.make_response(sheet, \"csv\")\n\nDevelopment guide\n================================================================================\n\nDevelopment steps for code changes\n\n#. git clone https://github.com/pyexcel/django-excel.git\n#. cd django-excel\n\nUpgrade your setup tools and pip. They are needed for development and testing only:\n\n#. pip install --upgrade setuptools pip\n\nThen install relevant development requirements:\n\n#. pip install -r rnd_requirements.txt # if such a file exists\n#. pip install -r requirements.txt\n#. pip install -r tests/requirements.txt\n\nOnce you have finished your changes, please provide test case(s), relevant documentation\nand update changelog.yml\n\n.. note::\n\n As to rnd_requirements.txt, usually, it is created when a dependent\n library is not released. Once the dependency is installed\n (will be released), the future\n version of the dependency in the requirements.txt will be valid.\n\n\nHow to test your contribution\n--------------------------------------------------------------------------------\n\nAlthough `nose` and `doctest` are both used in code testing, it is advisable\nthat unit tests are put in tests. `doctest` is incorporated only to make sure\nthe code examples in documentation remain valid across different development\nreleases.\n\nOn Linux/Unix systems, please launch your tests like this::\n\n $ make\n\nOn Windows, please issue this command::\n\n > test.bat\n\n\nBefore you commit\n------------------------------\n\nPlease run::\n\n $ make format\n\nso as to beautify your code otherwise your build may fail your unit test.\n\n\n\n\nLicense\n================================================================================\n\nNew BSD License\n\n\n\n5 contributors\n================================================================================\n\nIn alphabetical order:\n\n* `Andrei Lozhkin <https://github.com/lozhkinandrei>`_\n* `Minh-Long Do <https://github.com/minhlongdo>`_\n* `oon arfiandwi <https://github.com/oonid>`_\n* `Utpal Brahma <https://github.com/thebrahma>`_\n* `\uae40\uc0c1\uc5fd <https://github.com/yeop-sang>`_\n\nChange log\n================================================================================\n\n0.0.13 - 31.10.2025\n--------------------------------------------------------------------------------\n\n**Change:**\n\n#. Replace pkg_resources-based Django version check with django.get_version()\n#. Exclude .venv from flake8 check to simplify development\n\n0.0.12 - not released\n--------------------------------------------------------------------------------\n\n**Change:**\n\n#. Support for django 2.0.x\n#. Tested against django 4.1\n#. Change xlrd version <=1.2.0\n\n0.0.11 - not released\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. Test Support for django 3.x.x\n#. Tested against django 3.x.x\n\n0.0.10 - 11.01.2018\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `pyexcel-io#46 <https://github.com/pyexcel-webwares/pyexcel-io/issues/46>`_,\n expose `bulk_save` to django developers\n\n0.0.9 - 12.07.2017\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. bring isave_to_database and isave_book_to_database\n\n0.0.8 - 07.07.2017\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `pyexcel#39 <https://github.com/pyexcel-webwares/pyexcel/issues/39>`_,\n explicitly seeking at 0\n\n0.0.7 - 29.06.2017\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `pyexcel#38 <https://github.com/pyexcel-webwares/pyexcel/issues/38>`_,\n Support unicode code as download file name\n\n0.0.6 - 12.22.2016\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `pyexcel#26 <https://github.com/pyexcel-webwares/pyexcel/issues/26>`_, raise\n ioerror if content is empty.\n#. Use pyexcel-webio v0.0.9 so as to push out new version of pyexcel and its\n plugins.\n\n0.0.5 - 26.08.2016\n--------------------------------------------------------------------------------\n\n**Added:**\n\n#. Support for django 1.6.x\n#. Tested against django 1.10\n\n",
"bugtrack_url": null,
"license": "New BSD",
"summary": "A django middleware that provides one application programminginterface to read and write data in different excel file formats",
"version": "0.0.13",
"project_urls": {
"Download": "https://github.com/pyexcel-webwares/django-excel/archive/0.0.13.tar.gz",
"Homepage": "https://github.com/pyexcel-webwares/django-excel"
},
"split_keywords": [
"python",
" api",
" django"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bd994160d78404de888286358d6f18566e56ce9930996f7da559caff992d49e3",
"md5": "28839fed62032737bac03f7b59bb7fee",
"sha256": "6494129f7964c68df695fb39371f4219c3f51721c0eecbed66fedd55404b8a6f"
},
"downloads": -1,
"filename": "django_excel-0.0.13-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "28839fed62032737bac03f7b59bb7fee",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 15266,
"upload_time": "2025-11-01T00:19:44",
"upload_time_iso_8601": "2025-11-01T00:19:44.362493Z",
"url": "https://files.pythonhosted.org/packages/bd/99/4160d78404de888286358d6f18566e56ce9930996f7da559caff992d49e3/django_excel-0.0.13-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f9575588d9b1ea284fc63a390988782049c5e5f15e3ceb74f8c511a321e1ddb5",
"md5": "f9f8faff53736a426654fdb4e1782219",
"sha256": "a90f48329d61982e0bdac34bac5da041fbd86444610602cd3479de760ad7d0ae"
},
"downloads": -1,
"filename": "django_excel-0.0.13.tar.gz",
"has_sig": false,
"md5_digest": "f9f8faff53736a426654fdb4e1782219",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 505231,
"upload_time": "2025-11-01T00:19:45",
"upload_time_iso_8601": "2025-11-01T00:19:45.804070Z",
"url": "https://files.pythonhosted.org/packages/f9/57/5588d9b1ea284fc63a390988782049c5e5f15e3ceb74f8c511a321e1ddb5/django_excel-0.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-01 00:19:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyexcel-webwares",
"github_project": "django-excel",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pyexcel",
"specs": [
[
">=",
"0.5.7"
]
]
},
{
"name": "pyexcel-webio",
"specs": [
[
">=",
"0.1.2"
]
]
},
{
"name": "Django",
"specs": [
[
">=",
"1.6.1"
]
]
}
],
"lcname": "django-excel"
}
JSON
