📚 update documentations

Author: chfw

.gitignore

@@ -89,7 +89,11 @@ ENV/
 
 # Rope project settings
 .ropeproject
+
+# emacs
 *~
-commons/
-commons
+
+# moban hashes
 .moban.hashes
+.DS_store
+

.moban.yml

@@ -2,6 +2,7 @@ configuration:
   configuration_dir: "commons/config"
   template_dir:
   - "commons/templates"
+  - "setupmobans/templates"
   - ".moban.d"
   configuration: pyexcel_xlsxw.yml
 targets:
@@ -10,9 +11,9 @@ targets:
   - "docs/source/conf.py": "docs/source/conf.py.jj2"
   - .travis.yml: travis.yml
   - requirements.txt: 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
-  - .gitignore: .gitignore.jj2
+  - test.sh: test.script.jj2
+  - test.bat: test.script.jj2
+  - .gitignore: gitignore.jj2
   - "tests/requirements.txt": "tests/requirements.txt"

.travis.yml

@@ -3,7 +3,7 @@ language: python
 notifications:
   email: false
 python:
-  - pypy
+  - pypy-5.3.1
   - 3.6
   - 3.5
   - 3.4
@@ -25,9 +25,6 @@ matrix:
             - python-openpyxl
 
 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 ordereddict; fi
   - pip install --upgrade pip>8 setuptools>21
   - if [[ $TRAVIS_PYTHON_VERSION == "2.6" ]]; then pip install flake8==2.6.2; fi

README.rst

@@ -8,8 +8,11 @@ pyexcel-xlsxw - Let you focus on data, instead of xlsx format
 .. image:: https://api.travis-ci.org/pyexcel/pyexcel-xlsxw.svg?branch=master
    :target: http://travis-ci.org/pyexcel/pyexcel-xlsxw
 
-.. image:: https://codecov.io/github/pyexcel/pyexcel-xlsxw/coverage.png
-   :target: https://codecov.io/github/pyexcel/pyexcel-xlsxw
+.. image:: https://codecov.io/gh/pyexcel/pyexcel-xlsxw/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/pyexcel/pyexcel-xlsxw
+
+.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
+   :target: https://gitter.im/pyexcel/Lobby
 
 .. image:: https://readthedocs.org/projects/pyexcel-xlsxw/badge/?version=latest
    :target: http://pyexcel-xlsxw.readthedocs.org/en/latest/
@@ -217,19 +220,40 @@ Then install relevant development requirements:
 #. 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.rst.
+
+.. note::
+
+    As 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 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::
+
+    $ make
+
+On Windows systems, please issue this command::
 
-In order to update test environment, and documentation, additional steps are
-required:
+    > test.bat
+
+How to update test environment and update documentation
+---------------------------------------------------------
+
+Additional steps are required:
 
 #. pip install moban
+#. git clone https://github.com/moremoban/setupmobans.git # generic setup
 #. git clone https://github.com/pyexcel/pyexcel-commons.git commons
 #. make your changes in `.moban.d` directory, then issue command `moban`
 
-What is 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.
-
 What is pyexcel-commons
 ---------------------------------
 
@@ -240,18 +264,16 @@ What is .moban.d
 
 `.moban.d` stores the specific meta data for the library.
 
-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.
+Acceptance criteria
+-------------------
 
-On Linux/Unix systems, please launch your tests like this::
-
-    $ make
-
-On Windows systems, please issue this command::
-
-    > test.bat
+#. Has Test cases written
+#. Has all code lines tested
+#. Passes all Travis CI builds
+#. Has fair amount of documentation if your change is complex
+#. Please update CHANGELOG.rst
+#. Please add yourself to CONTRIBUTORS.rst
+#. Agree on NEW BSD License for your contribution
 
 
 .. testcode::

docs/source/conf.py

@@ -11,7 +11,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']

setup.py

@@ -7,26 +7,26 @@
 
 NAME = 'pyexcel-xlsxw'
 AUTHOR = 'C.W.'
-VERSION = '0.4.0'
+VERSION = ''
 EMAIL = '[email protected]'
 LICENSE = 'New BSD'
 DESCRIPTION = (
     'A wrapper library to write data in xlsx and xlsm format' +
     ''
 )
+URL = 'https://github.com/pyexcel/pyexcel-xlsxw'
+DOWNLOAD_URL = '%s/archive/0.4.0.tar.gz' % URL
+FILES = ['README.rst',  'CHANGELOG.rst']
 KEYWORDS = [
-    'excel',
-    'python',
-    'pyexcel',
     'xlsx'
+    'python'
 ]
 
 CLASSIFIERS = [
     'Topic :: Office/Business',
     'Topic :: Utilities',
     'Topic :: Software Development :: Libraries',
     'Programming Language :: Python',
-    'License :: OSI Approved :: BSD License',
     'Intended Audience :: Developers',
     'Programming Language :: Python :: 2.6',
     'Programming Language :: Python :: 2.7',
@@ -83,7 +83,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__':
@@ -93,7 +97,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,