📚 update documentations

.gitignore

@@ -1,6 +1,99 @@
-*.pyc
-*~
+# April 2016
+# reference: https://github.com/github/gitignore/blob/master/Python.gitignore
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
 .coverage
-pyexcel*-info
-build
-dist
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# emacs
+*~
+
+# 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_ods.yaml
 targets:
@@ -9,12 +10,13 @@ targets:
   - setup.py: setup.py
   - "docs/source/conf.py": "docs/source/conf.py.jj2"
   - .travis.yml: travis.yml
+  - .gitignore: gitignore.jj2
   - requirements.txt: requirements.txt
-  - LICENSE: LICENSE.jj2
+  - LICENSE: NEW_BSD_LICENSE.jj2
   - MANIFEST.in: MANIFEST.in.jj2
   - "tests/requirements.txt": "tests/requirements.txt"
-  - test.sh: test.sh.jj2
-  - test.bat: test.sh.jj2
+  - test.sh: test.script.jj2
+  - test.bat: test.script.jj2
   - "tests/test_filter.py": "tests/test_filter.py.jj2"
   - "tests/test_formatters.py": "tests/test_formatters.py"
   - "tests/test_stringio.py": "tests/test_stringio.py.jj2"

.travis.yml

@@ -10,9 +10,6 @@ python:
   - 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,8 +8,11 @@ pyexcel-ods - Let you focus on data, instead of ods format
 .. image:: https://api.travis-ci.org/pyexcel/pyexcel-ods.svg?branch=master
    :target: http://travis-ci.org/pyexcel/pyexcel-ods
 
-.. image:: https://codecov.io/github/pyexcel/pyexcel-ods/coverage.png
-   :target: https://codecov.io/github/pyexcel/pyexcel-ods
+.. image:: https://codecov.io/gh/pyexcel/pyexcel-ods/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/pyexcel/pyexcel-ods
+
+.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
+   :target: https://gitter.im/pyexcel/Lobby
 
 
 **pyexcel-ods** is a tiny wrapper library to read, manipulate and write data in
@@ -344,6 +347,7 @@ 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`
 
@@ -364,9 +368,10 @@ Acceptance criteria
 #. 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
 
-
 Credits
 ================================================================================
 

docs/source/conf.py

@@ -11,7 +11,7 @@ extensions = [
 ]
 
 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.cfg

@@ -0,0 +1,4 @@
+[metadata]
+description-file = README.rst
+[bdist_wheel]
+universal = 1

setup.py

@@ -14,10 +14,11 @@ DESCRIPTION = (
     'A wrapper library to read, manipulate and write data in ods format' +
     ''
 )
+URL = 'https://github.com/pyexcel/pyexcel-ods'
+DOWNLOAD_URL = '%s/archive/0.4.0.tar.gz' % URL
+FILES = ['README.rst',  'CHANGELOG.rst']
 KEYWORDS = [
-    'excel',
-    'python',
-    'pyexcel',
+    'python'
 ]
 
 CLASSIFIERS = [
@@ -25,7 +26,6 @@ CLASSIFIERS = [
     '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',
@@ -79,6 +79,10 @@ def filter_out_test_code(file_handle):
                 else:
                     found_test_code = False
                     yield line
+        else:
+            for keyword in ['|version|', '|today|']:
+                if keyword in line:
+                    break
             else:
                 yield line
 
@@ -90,7 +94,9 @@ if __name__ == '__main__':
         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,