📚 update project meta data

Author: chfw

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,10 +1,8 @@
 With your PR, here is a check list:
 
-- [ ] Has Test cases written
-- [ ] Has all code lines tested
-- [ ] Passes all Travis CI builds
+- [ ] Has test cases written?
+- [ ] Has all code lines tested?
+- [ ] Has `make format` been run?
+- [ ] Please update CHANGELOG.yml(not CHANGELOG.rst)
 - [ ] 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

.github/workflows/lint.yml

@@ -0,0 +1,20 @@
+name: lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: lint code
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+            python-version: 3.11
+      - name: lint
+        run: |
+          pip --use-deprecated=legacy-resolver install flake8
+          pip --use-deprecated=legacy-resolver install -r tests/requirements.txt
+          flake8 --exclude=.moban.d,docs,setup.py --builtins=unicode,xrange,long . 
+          python setup.py checkdocs

.github/workflows/moban-update.yml

@@ -0,0 +1,29 @@
+on: [push]
+
+jobs:
+  run_moban:
+    runs-on: ubuntu-latest
+    name: synchronize templates via moban
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+          token: ${{ secrets.PAT }}
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: '3.11'
+      - name: check changes
+        run: |
+          pip install markupsafe==2.0.1
+          pip install ruamel.yaml moban gitfs2 pypifs moban-jinja2-github moban-ansible
+          moban
+          git status
+          git diff --exit-code
+      - name: Auto-commit
+        if: failure()
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: >-
+            This is an auto-commit, updating project meta data,
+            such as changelog.rst, contributors.rst

.github/workflows/pythonpublish.yml

@@ -0,0 +1,31 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  pypi-publish:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    # Specifying a GitHub environment is optional, but strongly encouraged
+    environment: pypi
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      # retrieve your distributions here
+      - 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
+      - name: Build
+        run: |
+          python setup.py sdist bdist_wheel
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/tests.yml

@@ -0,0 +1,36 @@
+name: Run unit tests on Windows, Ubuntu and Mac
+
+on: [push, pull_request]
+
+jobs:
+
+  test:
+    name:  ${{ matrix.os }} / ${{ matrix.python_version }}
+    runs-on: ${{ matrix.os }}-latest 
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [Ubuntu]
+        python_version: ["3.9.16"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+            python-version:  ${{ matrix.python_version }}
+            architecture: x64
+
+      - name: install
+        run: |
+          pip --use-deprecated=legacy-resolver install -r requirements.txt
+          pip --use-deprecated=legacy-resolver install -r tests/requirements.txt
+          pip --use-deprecated=legacy-resolver install -r rnd_requirements.txt          
+      - name: test
+        run: |
+          pip freeze
+          nosetests --verbosity=3 --with-coverage --cover-package pyexcel_cli --cover-package tests tests --with-doctest --doctest-extension=.rst README.rst docs/source pyexcel_cli
+      - name: Upload coverage
+        uses: codecov/codecov-action@v1
+        with:
+          name:  ${{ matrix.os }} Python ${{ matrix.python-version }}

.gitignore

@@ -25,7 +25,6 @@ parts/
 sdist/
 var/
 wheels/
-pip-wheel-metadata/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
@@ -52,8 +51,10 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *.cover
+*.py,cover
 .hypothesis/
 .pytest_cache/
+cover/
 
 # Translations
 *.mo
@@ -63,6 +64,7 @@ coverage.xml
 *.log
 local_settings.py
 db.sqlite3
+db.sqlite3-journal
 
 # Flask stuff:
 instance/
@@ -75,6 +77,7 @@ instance/
 docs/_build/
 
 # PyBuilder
+.pybuilder/
 target/
 
 # Jupyter Notebook
@@ -85,17 +88,23 @@ profile_default/
 ipython_config.py
 
 # pyenv
-.python-version
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
 #   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don’t work, or not
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
 #   install all needed dependencies.
 #Pipfile.lock
 
-# celery beat schedule file
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
 celerybeat-schedule
+celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
@@ -127,6 +136,12 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
 # VirtualEnv rules
 # Virtualenv
 # http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
@@ -159,6 +174,7 @@ pip-selfcheck.json
 # Windows rules
 # Windows thumbnail cache files
 Thumbs.db
+Thumbs.db:encryptable
 ehthumbs.db
 ehthumbs_vista.db
 
@@ -264,13 +280,15 @@ flycheck_*.el
 # Vim rules
 # Swap
 [._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
 [._]*.sw[a-p]
 [._]s[a-rt-v][a-z]
 [._]ss[a-gi-z]
 [._]sw[a-p]
 
 # Session
 Session.vim
+Sessionx.vim
 
 # Temporary
 .netrwhist
@@ -281,7 +299,7 @@ tags
 [._]*.un~
 
 # JetBrains rules
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff
@@ -311,9 +329,14 @@ tags
 # When using Gradle or Maven with auto-import, you should exclude module files,
 # since they will be recreated, and may cause churn.  Uncomment if using
 # auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
 # .idea/modules.xml
 # .idea/*.iml
 # .idea/modules
+# *.iml
+# *.ipr
 
 # CMake
 cmake-build-*/
@@ -363,6 +386,7 @@ fabric.properties
 
 # SFTP configuration file
 sftp-config.json
+sftp-config-alt*.json
 
 # Package control specific files
 Package Control.last-run
@@ -400,6 +424,10 @@ tmtags
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
 
 # Xcode rules
 # Xcode
@@ -426,6 +454,9 @@ DerivedData/
 *.perspectivev3
 !default.perspectivev3
 
+## Gcc Patch
+/*.gcno
+
 # Eclipse rules
 .metadata
 bin/
@@ -477,12 +508,17 @@ local.properties
 
 # Annotation Processing
 .apt_generated/
+.apt_generated_test/
 
 # Scala IDE specific (Scala & Java development for Eclipse)
 .cache-main
 .scala_dependencies
 .worksheet
 
+# Uncomment this line if you wish to ignore the project description file.
+# Typically, this file would be tracked if it contains build/dependency configurations:
+#.project
+
 # TortoiseGit rules
 # Project-level settings
 /.tgitconfig
@@ -504,3 +540,7 @@ cscope.files
 cscope.out
 cscope.in.out
 cscope.po.out
+
+
+# remove moban hash dictionary
+.moban.hashes

.readthedocs.yml

@@ -0,0 +1,19 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf

.travis.yml

@@ -6,7 +6,7 @@ notifications:
 python:
   - &pypy2 pypy2.7-6.0
   - &pypy3 pypy3.5-6.0
-  - 3.8-dev
+  - 3.8
   - 3.7
   - 3.6
   - 3.5
@@ -17,33 +17,22 @@ stages:
   - moban
   - test
 
-.disable_global: &disable_global
-  addons: false
-  cache: false
-  env: {}
-  python: false
-  before_install: false
-  install: false
-  before_script: false
-  script: false
-  after_success: false
-  after_failure: false
-  before_deploy: false
-  deploy: false
 
 .lint: &lint
-  <<: *disable_global
   git:
     submodules: false
   python: 3.6
+  env:
+    - MINREQ=0
   stage: lint
   script: make lint
 
 .moban: &moban
-  <<: *disable_global
   python: 3.6
+  env:
+    - MINREQ=0
   stage: moban
-  install: pip install moban>=0.0.4
+  install: pip install moban gitfs2 pypifs moban-jinja2-github moban-ansible
   script:
     - moban
     - git diff --exit-code

CONTRIBUTORS.rst

@@ -0,0 +1,6 @@
+
+
+No contributors yet
+=======================
+
+* Your github link will be listed here after your PR is merged

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2019 by Onni Software Ltd. and its contributors
+Copyright (c) 2015-2025 by Onni Software Ltd. and its contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms of the software as well