🤝 synchronize the organisational meta data

chfw · chfw · commit b553d59e625b · 2020-06-08T22:53:21.000+01:00
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: chfw
+patreon: chfw
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,12 @@
+With your PR, here is a check list:
+
+- [ ] Has Test cases written
+- [ ] Has all code lines tested
+- [ ] Has `make format` been run?
+- [ ] Has `moban` been run?
+- [ ] Passes all Travis CI builds
+- [ ] Has fair amount of documentation if your change is complex
+- [ ] run 'make format' so as to confirm the pyexcel organisation's coding style
+- [ ] Please update CHANGELOG.rst
+- [ ] Please add yourself to CONTRIBUTORS.rst
+- [ ] Agree on NEW BSD License for your contribution
diff --git a/.github/workflows/pythonpublish.yml b/.github/workflows/pythonpublish.yml
@@ -0,0 +1,26 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          python setup.py sdist bdist_wheel
+          twine upload dist/*
diff --git a/.moban.d/custom_readme.rst.jj2 b/.moban.d/custom_readme.rst.jj2
diff --git a/.moban.d/custom_setup.py.jj2 b/.moban.d/custom_setup.py.jj2
diff --git a/.moban.d/tests/custom_req.txt.jj2 b/.moban.d/tests/custom_req.txt.jj2
diff --git a/.moban.yml b/.moban.yml
@@ -1,27 +1,10 @@
-requires:
-  - type: git
-    url: https://github.com/moremoban/pypi-mobans
-    submodule: true
-  - https://github.com/pyexcel/pyexcel-mobans
+overrides: "git://github.com/pyexcel/pyexcel-mobans!/mobanfile.yaml"
 configuration:
-  configuration_dir: "pyexcel-mobans:config"
-  template_dir:
-    - "pyexcel-mobans:templates"
-    - "pypi-mobans:templates"
-    - ".moban.d"
   configuration: pyexcel-pdfr.yml
 targets:
-  - README.rst: README.rst
-  - setup.py: setup.py
-  - requirements.txt: requirements.txt
+  - README.rst: custom_readme.rst.jj2
+  - setup.py: custom_setup.py.jj2
   - MANIFEST.in: MANIFEST.in.jj2
-  - "tests/requirements.txt": "tests/requirements.txt"
-  - test.sh: test.script.jj2
-  - test.bat: test.script.jj2
-  - .gitignore: gitignore.jj2
+  - "tests/requirements.txt": "tests/custom_req.txt.jj2"
   - "docs/source/conf.py": "docs/source/conf.py.jj2"
   - "pyexcel_pdfr/_version.py": version.py.jj2
-  - lint.sh: lint.script.jj2
-  - output: CHANGELOG.rst
-    configuration: changelog.yml
-    template: CHANGELOG.rst.jj2
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,7 +4,6 @@ Change log
 0.5.0-rc1 - 14.03.2019
 --------------------------------------------------------------------------------
 
-first release
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+**first release**
 
 #. read tabular data out from pdf format
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2015-2017 by Onni Software Ltd. and its contributors
+Copyright (c) 2015-2019 by Onni Software Ltd. and its contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms of the software as well
@@ -13,13 +13,9 @@ that the following conditions are met:
   and/or other materials provided with the distribution.
 
 * Neither the name of 'pyexcel-pdfr' nor the names of the contributors
-  may not be used to endorse or promote products derived from this software
+  may be used to endorse or promote products derived from this software
   without specific prior written permission.
 
-Please also note that this library contains a few functions and test fixtures
-from messytables which is under MIT license and please see their license
-at the end.
-
 THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
@@ -32,23 +28,3 @@ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE AND DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 DAMAGE.
-
-Copyright (c) 2012-2017 The Open Knowledge Foundation Ltd.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
diff --git a/README.rst b/README.rst
@@ -3,17 +3,25 @@ pyexcel-pdfr - 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/pyexcel
+   :target: https://www.patreon.com/chfw
 
-.. image:: https://api.bountysource.com/badge/team?team_id=288537
-   :target: https://salt.bountysource.com/teams/chfw-pyexcel
+.. image:: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg
+   :target: https://awesome-python.com/#specific-formats-processing
 
 .. image:: https://travis-ci.org/pyexcel/pyexcel-pdfr.svg?branch=master
    :target: http://travis-ci.org/pyexcel/pyexcel-pdfr
 
 .. image:: https://codecov.io/gh/pyexcel/pyexcel-pdfr/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/pyexcel/pyexcel-pdfr
 
+.. image:: https://badge.fury.io/py/pyexcel-pdfr.svg
+   :target: https://pypi.org/project/pyexcel-pdfr
+
+
+.. image:: https://pepy.tech/badge/pyexcel-pdfr/month
+   :target: https://pepy.tech/project/pyexcel-pdfr/month
+
+
 .. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
    :target: https://gitter.im/pyexcel/Lobby
 
@@ -24,7 +32,7 @@ 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>`_
+product, please support me on github, `patreon <https://www.patreon.com/bePatron?u=5537627>`_
 or `bounty source <https://salt.bountysource.com/teams/chfw-pyexcel>`_ to maintain
 the project and develop it further.
 
@@ -107,38 +115,33 @@ On Windows systems, please issue this command::
 
     > test.bat
 
-How to update test environment and update documentation
+
+Before you commit
+------------------------------
+
+Please run::
+
+    $ make format
+
+so as to beautify your code otherwise travis-ci may fail your unit test.
+
+
+And make sure you would have run moban command
 ---------------------------------------------------------
 
 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`
+#. moban
 
-What is pyexcel-commons
----------------------------------
-
-Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in `pyexcel-commons` project.
+otherwise travis-ci may also fail your unit test.
 
 What is .moban.d
 ---------------------------------
 
 `.moban.d` stores the specific meta data for the library.
 
-Acceptance criteria
--------------------
-
-#. Has Test cases written
-#. Has all code lines tested
-#. Passes all Travis CI builds
-#. Has fair amount of documentation if your change is complex
-#. run 'make format' so as to confirm the pyexcel organisation's coding style
-#. Please update CHANGELOG.rst
-#. Please add yourself to CONTRIBUTORS.rst
-#. Agree on NEW BSD License for your contribution
-
 
 
 License
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -7,7 +7,7 @@
 #
 # This file only contains a selection of the most common options. For a full
 # list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Path setup --------------------------------------------------------------
 
@@ -21,9 +21,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'pyexcel'
-copyright = 'copyright 2015-2019 Onni Software Ltd.'
-author = 'Onni Software Ltd.'
+project = 'pyexcel-pdfr'
+copyright = '2015-2019 Onni Software Ltd.'
+author = 'C.W.'
 # The short X.Y version
 version = '0.5.0-rc1'
 # The full version, including alpha/beta/rc tags
@@ -68,7 +68,7 @@
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {'https://docs.python.org/3/': None}
 # TODO: html_theme not configurable upstream
 html_theme = 'default'
 
@@ -83,3 +83,4 @@
 intersphinx_mapping.update({
     'pyexcel': ('http://pyexcel.readthedocs.io/en/latest/', None),
 })
+master_doc = "index"
diff --git a/lint.sh b/lint.sh
@@ -1 +1,2 @@
-flake8 . --exclude=.moban.d,docs --builtins=unicode,xrange,long
+pip install flake8
+flake8 . --exclude=.moban.d,docs,setup.py --builtins=unicode,xrange,long
diff --git a/pyexcel_pdfr/_version.py b/pyexcel_pdfr/_version.py
@@ -1,2 +1,2 @@
-__version__ = "0.5.0-rc1"
-__author__ = "C.W."
+__version__ = '0.5.0-rc1'
+__author__ = 'C.W.'
diff --git a/setup.py b/setup.py
diff --git a/test.sh b/test.sh

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-flake8 . --exclude=.moban.d,docs --builtins=unicode,xrange,long`
	`1`	`+pip install flake8`
	`2`	`+flake8 . --exclude=.moban.d,docs,setup.py --builtins=unicode,xrange,long`