🤝 take latest code from setupmobans, carrying LICENSE file, pyexcel/pyexcel#103, update docs pyexcel/pyexcel#104

chfw · chfw · commit e616a3aa109b · 2017-10-20T23:56:47.000+01:00
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,5 @@
 include README.rst
+include LICENSE
 include CHANGELOG.rst
 prune mysite
 prune polls
diff --git a/README.rst b/README.rst
@@ -25,7 +25,7 @@ product, please `support me on patreon <https://www.patreon.com/bePatron?u=55376
 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 to. As a patreon, you will receive
+you feel like. 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 invest
@@ -56,15 +56,16 @@ well as on file system. This library can turn the excel data into a list of list
 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 developing an excel file
-driven web applications for non-technical office workers: such as office assistant,
-human resource administrator. The fact is that not all people know the
-difference among various excel formats: csv, xls, xlsx. Instead of training those people
+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
-to you application, all you need is to install an extra pyexcel plugin. No code change
-to your application. Looking at the community, this library and its associated ones try
-to become a small and easy to install alternative to Pandas.
+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:
@@ -90,26 +91,22 @@ The highlighted features are:
    `pyexcel-xls`_           xls, xlsx(read only),   `xlrd`_,          same as above
                             xlsm(read only)         `xlwt`_
    `pyexcel-xlsx`_          xlsx                    `openpyxl`_       same as above
-   `pyexcel-xlsxw`_         xlsx(write only)        `XlsxWriter`_     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
+   ======================== ======================= ================= ==================
+
+.. 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-odsr`_          read only for ods, fods lxml              same as above
    `pyexcel-htmlr`_         html(read only)         lxml,html5lib     same as above
-   `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-io: https://github.com/pyexcel/pyexcel-io
 .. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls
 .. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx
@@ -126,6 +123,25 @@ The highlighted features are:
 .. _pyexcel-ezodf: https://github.com/pyexcel/pyexcel-ezodf
 .. _odfpy: https://github.com/eea/odfpy
 
+.. 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
@@ -186,7 +202,8 @@ Tested Django Versions
 
 Installation
 ================================================================================
-You can install it via pip:
+
+You can install django-excel via pip:
 
 .. code-block:: bash
 
@@ -219,9 +236,10 @@ Here is the example viewing function codes:
 
 .. code-block:: python
 
-    from django.shortcuts import render
+    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):
@@ -237,20 +255,14 @@ Here is the example viewing function codes:
                 return HttpResponseBadRequest()
         else:
             form = UploadFileForm()
-        return render(request, 'upload_form.html', {'form': form})
+        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")
 
-.. code-block:: html
-
-    <form action="/upload-file/" enctype="multipart/form-data" method="post">
-        {% csrf_token %}
-        {{ form }}
-        <input type="submit" value="Submit" />
-    </form>
-
 Development guide
 ================================================================================
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -30,15 +30,16 @@ well as on file system. This library can turn the excel data into a list of list
 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 developing an excel file
-driven web applications for non-technical office workers: such as office assistant,
-human resource administrator. The fact is that not all people know the
-difference among various excel formats: csv, xls, xlsx. Instead of training those people
+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
-to you application, all you need is to install an extra pyexcel plugin. No code change
-to your application. Looking at the community, this library and its associated ones try
-to become a small and easy to install alternative to Pandas.
+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:
@@ -64,26 +65,22 @@ The highlighted features are:
    `pyexcel-xls`_           xls, xlsx(read only),   `xlrd`_,          same as above
                             xlsm(read only)         `xlwt`_
    `pyexcel-xlsx`_          xlsx                    `openpyxl`_       same as above
-   `pyexcel-xlsxw`_         xlsx(write only)        `XlsxWriter`_     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
+   ======================== ======================= ================= ==================
+
+.. 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-odsr`_          read only for ods, fods lxml              same as above
    `pyexcel-htmlr`_         html(read only)         lxml,html5lib     same as above
-   `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-io: https://github.com/pyexcel/pyexcel-io
 .. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls
 .. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx
@@ -100,6 +97,25 @@ The highlighted features are:
 .. _pyexcel-ezodf: https://github.com/pyexcel/pyexcel-ezodf
 .. _odfpy: https://github.com/eea/odfpy
 
+.. 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
@@ -139,7 +155,8 @@ and export from SQL databases, information analysis and persistence. It uses
 Installation
 -------------------
 
-You can install it via pip:
+
+You can install django-excel via pip:
 
 .. code-block:: bash
 
@@ -191,7 +208,7 @@ product, please `support me on patreon <https://www.patreon.com/bePatron?u=55376
 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 to. As a patreon, you will receive
+you feel like. 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 invest
diff --git a/setup.py b/setup.py
@@ -1,10 +1,9 @@
-try:
-    from setuptools import setup, find_packages
-except ImportError:
-    from ez_setup import use_setuptools
-    use_setuptools()
-    from setuptools import setup, find_packages
+# Template by setupmobans
+import os
 import sys
+import codecs
+from shutil import rmtree
+from setuptools import setup, find_packages, Command
 PY2 = sys.version_info[0] == 2
 PY26 = PY2 and sys.version_info[1] < 7
 
@@ -20,7 +19,7 @@
 )
 URL = 'https://github.com/pyexcel/django-excel'
 DOWNLOAD_URL = '%s/archive/0.0.9.tar.gz' % URL
-FILES = ['README.rst', 'CHANGELOG.rst']
+FILES = ['README.rst',  'CHANGELOG.rst']
 KEYWORDS = [
     'API',
     'Django',
@@ -67,6 +66,42 @@
     'xlsx': ['pyexcel-xlsx>=0.4.0'],
     'ods': ['pyexcel-ods3>=0.4.0'],
 }
+PUBLISH_COMMAND = '{0} setup.py sdist bdist_wheel upload -r pypi'.format(
+    sys.executable)
+GS_COMMAND = ('gs django-excel v0.0.9 ' +
+              "Find 0.0.9 in changelog for more details")
+here = os.path.abspath(os.path.dirname(__file__))
+
+
+class PublishCommand(Command):
+    """Support setup.py upload."""
+
+    description = 'Build and publish the package on github and pypi'
+    user_options = []
+
+    @staticmethod
+    def status(s):
+        """Prints things in bold."""
+        print('\033[1m{0}\033[0m'.format(s))
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        try:
+            self.status('Removing previous builds...')
+            rmtree(os.path.join(here, 'dist'))
+        except OSError:
+            pass
+
+        self.status('Building Source and Wheel (universal) distribution...')
+        if os.system(GS_COMMAND) == 0:
+            os.system(PUBLISH_COMMAND)
+
+        sys.exit()
 
 
 def read_files(*files):
@@ -80,7 +115,7 @@ def read_files(*files):
 
 def read(afile):
     """Read a file into setup"""
-    with open(afile, 'r') as opened_file:
+    with codecs.open(afile, 'r', 'utf-8') as opened_file:
         content = filter_out_test_code(opened_file)
         content = "".join(list(content))
         return content
@@ -128,5 +163,9 @@ def filter_out_test_code(file_handle):
         packages=PACKAGES,
         include_package_data=True,
         zip_safe=False,
-        classifiers=CLASSIFIERS
+        classifiers=CLASSIFIERS,
+        setup_requires=['gease'],
+        cmdclass={
+            'publish': PublishCommand,
+        }
     )
