📚 update documentation

.moban.yml

@@ -2,6 +2,7 @@ configuration:
   configuration_dir: "commons/config"
   template_dir:
   - "commons/templates"
+  - "setupmobans/templates"
   - ".moban.d"
   configuration: pyexcel_io.yaml
 targets:
@@ -10,9 +11,9 @@ targets:
   - .travis.yml: travis.yml.jj2
   - requirements.txt: requirements.txt.jj2
   - "tests/requirements.txt": "tests/requirements.txt"
-  - LICENSE: LICENSE.jj2
+  - LICENSE: NEW_BSD_LICENSE.jj2
   - MANIFEST.in: MANIFEST.in.jj2
-  - test.sh: test.sh.jj2
-  - test.bat: test.sh.jj2
+  - test.sh: test.script.jj2
+  - test.bat: test.script.jj2
   - README.rst: README.rst
-  - "docs/source/index.rst": "docs/source/index.rst"
+  - "docs/source/index.rst": "docs/source/index.rst"

.travis.yml

@@ -3,17 +3,14 @@ language: python
 notifications:
   email: false
 python:
-  - pypy
+  - pypy-5.3.1
   - 3.6
   - 3.5
   - 3.4
   - 3.3
   - 2.7
   - 2.6
 before_install:
-  - cd $HOME
-  - "if [[ $TRAVIS_PYTHON_VERSION == 'pypy' ]]; then deactivate && wget https://bitbucket.org/squeaky/portable-pypy/downloads/pypy-5.7.1-linux_x86_64-portable.tar.bz2 -O - | tar -jxf - && echo 'Setting up aliases...' && ln -s pypy-5.7.1-linux_x86_64-portable pypy2-latest && export PATH=$HOME/pypy2-latest/bin/:$PATH && virtualenv --no-site-packages --python ~/pypy2-latest/bin/pypy pypy2-env && echo 'Creating custom env...' && source pypy2-env/bin/activate && python -V; fi"
-  - cd -
   - if [[ $TRAVIS_PYTHON_VERSION == "2.6" ]]; then pip install flake8==2.6.2; fi
   - if [[ -f min_requirements.txt && "$MINREQ" -eq 1 ]]; then
       mv min_requirements.txt requirements.txt ;

README.rst

@@ -8,20 +8,37 @@ pyexcel-io - Let you focus on data, instead of file formats
 .. image:: https://api.travis-ci.org/pyexcel/pyexcel-io.svg?branch=master
    :target: http://travis-ci.org/pyexcel/pyexcel-io
 
-.. image:: https://codecov.io/github/pyexcel/pyexcel-io/coverage.png
-   :target: https://codecov.io/github/pyexcel/pyexcel-io
+.. image:: https://codecov.io/gh/pyexcel/pyexcel-io/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/pyexcel/pyexcel-io
 
 .. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
    :target: https://gitter.im/pyexcel/Lobby
 
 .. image:: https://readthedocs.org/projects/pyexcel-io/badge/?version=latest
    :target: http://pyexcel-io.readthedocs.org/en/latest/
 
+Support the project
+================================================================================
+
+If your company has embedded pyexcel and its components into a revenue generating
+product, please `support me on patreon <https://www.patreon.com/bePatron?u=5537627>`_ to
+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
+`early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>`_.
+
+With your financial support, I will be able to invest
+a little bit more time in coding, documentation and writing interesting posts.
+
+
 Known constraints
 ==================
 
 Fonts, colors and charts are not supported.
 
+Introduction
+================================================================================
 
 **pyexcel-io** provides **one** application programming interface(API) to read
 and write the data in excel format, import the data into and export the data
@@ -48,6 +65,7 @@ sqlalchemy supported databases. Its supported file formats are extended to cover
                                                     lxml            3.5, 3.6
    `pyexcel-ods`_           ods                     `odfpy`_        same as above
    `pyexcel-odsr`_          ods(read only)          lxml            same as above
+   `pyexcel-htmlr`_         html(read only)         lxml,html5lib   same as above
    ======================== ======================= =============== ==================
 
 .. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
@@ -57,6 +75,7 @@ sqlalchemy supported databases. Its supported file formats are extended to cover
 .. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3
 .. _pyexcel-odsr: https://github.com/pyexcel/pyexcel-odsr
 .. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw
+.. _pyexcel-htmlr: https://github.com/pyexcel/pyexcel-htmlr
 
 .. _xlrd: https://github.com/python-excel/xlrd
 .. _xlwt: https://github.com/python-excel/xlwt
@@ -106,21 +125,6 @@ or clone it and install it:
 
 
 
-Support the project
-================================================================================
-
-If your company has embedded pyexcel and its components into a revenue generating
-product, please `support me on patreon <https://www.patreon.com/bePatron?u=5537627>`_ to
-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
-`early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>`_.
-
-With your financial support, I will be able to invest
-a little bit more time in coding, documentation and writing interesting posts.
-
-
 Development guide
 ================================================================================
 
@@ -193,6 +197,7 @@ Acceptance criteria
 
 
 
+
 License
 ================================================================================
 

docs/source/conf.py

@@ -13,7 +13,7 @@
 ]
 
 intersphinx_mapping = {
-    'pyexcel': ('http://pyexcel.readthedocs.org/en/latest/', None),
+    'pyexcel': ('http://pyexcel.readthedocs.io/en/latest/', None),
 }
 spelling_word_list_filename = 'spelling_wordlist.txt'
 templates_path = ['_templates']

docs/source/index.rst

@@ -77,6 +77,7 @@ For individual excel file formats, please install them as you wish:
                                                     lxml            3.5, 3.6
    `pyexcel-ods`_           ods                     `odfpy`_        same as above
    `pyexcel-odsr`_          ods(read only)          lxml            same as above
+   `pyexcel-htmlr`_         html(read only)         lxml,html5lib   same as above
    ======================== ======================= =============== ==================
 
 .. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
@@ -86,6 +87,7 @@ For individual excel file formats, please install them as you wish:
 .. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3
 .. _pyexcel-odsr: https://github.com/pyexcel/pyexcel-odsr
 .. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw
+.. _pyexcel-htmlr: https://github.com/pyexcel/pyexcel-htmlr
 
 .. _xlrd: https://github.com/python-excel/xlrd
 .. _xlwt: https://github.com/python-excel/xlwt

setup.py

@@ -18,15 +18,16 @@
     'format and to/from databases' +
     ''
 )
+URL = 'https://github.com/pyexcel/pyexcel-io'
+DOWNLOAD_URL = '%s/archive/0.4.2.tar.gz' % URL
+FILES = ['README.rst', 'CHANGELOG.rst']
 KEYWORDS = [
-    'excel',
-    'python',
-    'pyexcel',
     'API',
     'tsv',
     'tsvz'
     'csv',
     'csvz'
+    'python'
 ]
 
 CLASSIFIERS = [
@@ -94,7 +95,11 @@ def filter_out_test_code(file_handle):
                     found_test_code = False
                     yield line
         else:
-            yield line
+            for keyword in ['|version|', '|today|']:
+                if keyword in line:
+                    break
+            else:
+                yield line
 
 
 if __name__ == '__main__':
@@ -104,7 +109,9 @@ def filter_out_test_code(file_handle):
         version=VERSION,
         author_email=EMAIL,
         description=DESCRIPTION,
-        long_description=read_files('README.rst', 'CHANGELOG.rst'),
+        url=URL,
+        download_url=DOWNLOAD_URL,
+        long_description=read_files(*FILES),
         license=LICENSE,
         keywords=KEYWORDS,
         extras_require=EXTRAS_REQUIRE,