🚀 github actions for moban and automatically extract contributors
This commit is contained in:
parent
ca35d108d7
commit
de6344e11e
|
@ -3,10 +3,9 @@ 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?
|
||||
- [ ] Please update CHANGELOG.yml(not CHANGELOG.rst)
|
||||
- [ ] 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
|
||||
- [ ] Please add yourself to 'contributors' section of pyexcel-io.yml (if not found, please use CONTRIBUTORS.rst)
|
||||
- [ ] Agree on NEW BSD License for your contribution
|
||||
|
|
|
@ -0,0 +1,27 @@
|
|||
on: [push]
|
||||
|
||||
jobs:
|
||||
run_moban:
|
||||
runs-on: ubuntu-latest
|
||||
name: synchronize templates via moban
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
ref: ${{ github.head_ref }}
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v1
|
||||
with:
|
||||
python-version: '3.7'
|
||||
- name: check changes
|
||||
run: |
|
||||
pip install moban gitfs2 pypifs
|
||||
moban
|
||||
git status
|
||||
git diff --exit-code
|
||||
- name: Auto-commit
|
||||
if: failure()
|
||||
uses: docker://cdssnc/auto-commit-github-action
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
args: This is an auto-commit, updating project meta data, such as changelog.rst, contributors.rst
|
|
@ -0,0 +1,10 @@
|
|||
|
||||
4 contributors
|
||||
================================================================================
|
||||
|
||||
In alphabetical order:
|
||||
|
||||
* `Antherkiv <https://api.github.com/users/antherkiv>`_
|
||||
* `John Vandenberg <https://api.github.com/users/jayvdb>`_
|
||||
* `Stephen J. Fuhry <https://api.github.com/users/fuhrysteve>`_
|
||||
* `Stephen Rauch <https://api.github.com/users/stephenrauch>`_
|
2
LICENSE
2
LICENSE
|
@ -1,4 +1,4 @@
|
|||
Copyright (c) 2015-2019 by Onni Software Ltd. and its contributors
|
||||
Copyright (c) 2015-2020 by Onni Software Ltd. and its contributors
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms of the software as well
|
||||
|
|
16
Makefile
16
Makefile
|
@ -1,23 +1,19 @@
|
|||
all: test
|
||||
|
||||
test:
|
||||
test: lint
|
||||
bash test.sh
|
||||
|
||||
install_test:
|
||||
pip install -r tests/requirements.txt
|
||||
|
||||
document:
|
||||
sphinx-autogen -o docs/source/generated/ docs/source/*.rst
|
||||
sphinx-build -b html docs/source/ docs/build/
|
||||
|
||||
format:
|
||||
isort -y $(find pyexcel_io -name "*.py"|xargs echo) $(find tests -name "*.py"|xargs echo)
|
||||
black -l 79 pyexcel_io
|
||||
black -l 79 tests
|
||||
git-diff-check:
|
||||
git diff --exit-code
|
||||
|
||||
lint:
|
||||
bash lint.sh
|
||||
|
||||
format:
|
||||
bash format.sh
|
||||
|
||||
git-diff-check:
|
||||
git diff --exit-code
|
||||
|
||||
|
|
41
README.rst
41
README.rst
|
@ -98,6 +98,24 @@ sqlalchemy supported databases. Its supported file formats are extended to cover
|
|||
======================== ======================= ================= ==================
|
||||
|
||||
|
||||
Plugin shopping guide
|
||||
------------------------
|
||||
|
||||
Except csv files, xls, xlsx and ods files are a zip of a folder containing a lot of
|
||||
xml files
|
||||
|
||||
The dedicated readers for excel files can stream read
|
||||
|
||||
|
||||
In order to manage the list of plugins installed, you need to use pip to add or remove
|
||||
a plugin. When you use virtualenv, you can have different plugins per virtual
|
||||
environment. In the situation where you have multiple plugins that does the same thing
|
||||
in your environment, you need to tell pyexcel which plugin to use per function call.
|
||||
For example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr.
|
||||
You need to append get_array(..., library='pyexcel-odsr').
|
||||
|
||||
|
||||
|
||||
.. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
|
||||
.. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls
|
||||
.. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx
|
||||
|
@ -120,13 +138,6 @@ sqlalchemy supported databases. Its supported file formats are extended to cover
|
|||
.. _odfpy: https://github.com/eea/odfpy
|
||||
|
||||
|
||||
In order to manage the list of plugins installed, you need to use pip to add or remove
|
||||
a plugin. When you use virtualenv, you can have different plugins per virtual
|
||||
environment. In the situation where you have multiple plugins that does the same thing
|
||||
in your environment, you need to tell pyexcel which plugin to use per function call.
|
||||
For example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr.
|
||||
You need to append get_array(..., library='pyexcel-odsr').
|
||||
|
||||
.. rubric:: Footnotes
|
||||
|
||||
.. [#f1] zipped csv file
|
||||
|
@ -214,22 +225,6 @@ Please run::
|
|||
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
|
||||
#. make your changes in `.moban.d` directory, then issue command `moban`
|
||||
#. moban
|
||||
|
||||
otherwise travis-ci may also fail your unit test.
|
||||
|
||||
What is .moban.d
|
||||
---------------------------------
|
||||
|
||||
`.moban.d` stores the specific meta data for the library.
|
||||
|
||||
|
||||
|
||||
License
|
||||
|
|
|
@ -23,8 +23,8 @@ DESCRIPTION = (
|
|||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'pyexcel-io'
|
||||
copyright = '2015-2019 Onni Software Ltd.'
|
||||
author = 'C.W.'
|
||||
copyright = '2015-2020 Onni Software Ltd.'
|
||||
author = 'chfw'
|
||||
# The short X.Y version
|
||||
version = '0.6.0'
|
||||
# The full version, including alpha/beta/rc tags
|
||||
|
|
Loading…
Reference in New Issue