Skip to content

Commit a76eba1

Browse files
chfwchfw
committed
📚 update project meta data
1 parent 12599f2 commit a76eba1

15 files changed

+267
-225
lines changed

‎.github/FUNDING.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# These are supported funding model platforms
2+
3+
github: chfw
4+
patreon: chfw

‎.github/PULL_REQUEST_TEMPLATE.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
With your PR, here is a check list:
2+
3+
- [ ] Has Test cases written
4+
- [ ] Has all code lines tested
5+
- [ ] Has `make format` been run?
6+
- [ ] Has `moban` been run?
7+
- [ ] Passes all Travis CI builds
8+
- [ ] Has fair amount of documentation if your change is complex
9+
- [ ] run 'make format' so as to confirm the pyexcel organisation's coding style
10+
- [ ] Please update CHANGELOG.rst
11+
- [ ] Please add yourself to CONTRIBUTORS.rst
12+
- [ ] Agree on NEW BSD License for your contribution

‎.github/workflows/pythonpublish.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Upload Python Package
2+
3+
on:
4+
release:
5+
types: [created]
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v1
12+
- name: Set up Python
13+
uses: actions/setup-python@v1
14+
with:
15+
python-version: '3.x'
16+
- name: Install dependencies
17+
run: |
18+
python -m pip install --upgrade pip
19+
pip install setuptools wheel twine
20+
- name: Build and publish
21+
env:
22+
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
23+
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
24+
run: |
25+
python setup.py sdist bdist_wheel
26+
twine upload dist/*

‎.moban.d/README.rst renamed to ‎.moban.d/custom_readme.rst.jj2

File renamed without changes.

‎.moban.d/setup.py renamed to ‎.moban.d/custom_setup.py.jj2

File renamed without changes.

‎.moban.d/tests/requirements.txt renamed to ‎.moban.d/tests/custom_requirements.txt.jj2

File renamed without changes.

‎.moban.yml

+4-14
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,9 @@
1+
overrides: "git://github.com/pyexcel/pyexcel-mobans!/mobanfile.yaml"
12
configuration:
2-
configuration_dir: "commons/config"
3-
template_dir:
4-
- "commons/templates"
5-
- "setupmobans/templates"
6-
- ".moban.d"
73
configuration: pyexcel_webio.yaml
84
targets:
9-
- setup.py: setup.py
5+
- setup.py: custom_setup.py.jj2
106
- "docs/source/conf.py": "docs/source/conf.py.jj2"
117
- .travis.yml: travis.yml.jj2
12-
- requirements.txt: requirements.txt
13-
- LICENSE: NEW_BSD_LICENSE.jj2
14-
- MANIFEST.in: MANIFEST.in.jj2
15-
- .gitignore: gitignore.jj2
16-
- test.sh: test.script.jj2
17-
- test.bat: test.script.jj2
18-
- "tests/requirements.txt": "tests/requirements.txt"
19-
- README.rst: README.rst
8+
- "tests/requirements.txt": "tests/custom_requirements.txt.jj2"
9+
- README.rst: custom_readme.rst.jj2

‎.travis.yml

+40-5
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,55 @@
11
sudo: false
2+
dist: xenial
23
language: python
34
notifications:
45
email: false
56
python:
6-
- pypy-5.3.1
7+
- &pypy2 pypy2.7-6.0
8+
- &pypy3 pypy3.5-6.0
9+
- 3.8
10+
- 3.7
711
- 3.6
812
- 3.5
9-
- 3.4
10-
- 3.3
1113
- 2.7
14+
15+
stages:
16+
- lint
17+
- moban
18+
- test
19+
20+
21+
.lint: &lint
22+
git:
23+
submodules: false
24+
python: 3.6
25+
env:
26+
- MINREQ=0
27+
stage: lint
28+
script: make lint
29+
30+
.moban: &moban
31+
python: 3.6
32+
env:
33+
- MINREQ=0
34+
stage: moban
35+
install: pip install moban>=0.0.4 gitfs2 pypifs
36+
script:
37+
- moban
38+
- git diff --exit-code
39+
40+
jobs:
41+
include:
42+
- *moban
43+
- *lint
44+
45+
stage: test
46+
1247
before_install:
13-
- if [[ $TRAVIS_PYTHON_VERSION == "2.6" ]]; then pip install flake8==2.6.2; fi
1448
- if [[ -f min_requirements.txt && "$MINREQ" -eq 1 ]]; then
1549
mv min_requirements.txt requirements.txt ;
1650
fi
17-
- test ! -f rnd_requirements.txt || pip install --no-deps -r rnd_requirements.txt
51+
- test ! -f rnd_requirements.txt ||
52+
pip install --no-deps -r rnd_requirements.txt
1853
- test ! -f rnd_requirements.txt || pip install -r rnd_requirements.txt ;
1954
- pip install -r tests/requirements.txt
2055
script:

‎CHANGELOG.rst

-101
Original file line numberDiff line numberDiff line change
@@ -1,103 +1,2 @@
11
Change log
22
================================================================================
3-
4-
0.1.4 - 23.10.2017
5-
--------------------------------------------------------------------------------
6-
7-
#. `#105 <https://github.com/pyexcel/pyexcel/issues/105>`_, remove gease
8-
from setup_requires, introduced by 0.1.3.
9-
#. removed testing against python 2.6
10-
11-
0.1.3 - 20.10.2017
12-
--------------------------------------------------------------------------------
13-
14-
added
15-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
16-
17-
#. `#103 <https://github.com/pyexcel/pyexcel/pull/103>`_, include LICENSE file
18-
in MANIFEST.in, meaning LICENSE file will appear in the released tar ball.
19-
20-
updated
21-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
22-
23-
#. Take pyexcel 0.5.5 as dependency
24-
25-
26-
0.1.2 - 12.07.2017
27-
--------------------------------------------------------------------------------
28-
29-
Added
30-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
31-
32-
#. To bring isave_as and isave_book_as to web clients
33-
34-
Updated
35-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
36-
37-
#. replaced monkey-patching initialization step. For all extension developer,
38-
please call init_webio(your_response_function)
39-
40-
0.1.1 - 07.07.2017
41-
--------------------------------------------------------------------------------
42-
43-
Updated
44-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
45-
46-
#. `#5 <https://github.com/pyexcel/pyexcel-webio/issues/5>`_: explicitly seek
47-
at 0 for incoming file
48-
49-
50-
0.1.0 - 06.07.2017
51-
--------------------------------------------------------------------------------
52-
53-
Added
54-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
55-
56-
#. To bring iget_array, iget_records to web clients
57-
#. To facilitate the use of pyexcel-handsontable, pyexcel-pygal,
58-
pyexcel-matplotlib
59-
60-
0.0.11 - 04.03.2017
61-
--------------------------------------------------------------------------------
62-
63-
Updated
64-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
65-
66-
#. `#4 <https://github.com/pyexcel/pyexcel-webio/issues/4>`_: extra keywords
67-
were not passed on to pyexcel
68-
69-
0.0.10 - 22.12.2016
70-
--------------------------------------------------------------------------------
71-
72-
Updated
73-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
74-
75-
#. `#3 <https://github.com/pyexcel/pyexcel-webio/issues/3>`_: raise exception
76-
if uploaded file has no content read.
77-
78-
79-
0.0.9 - 22.12.2016
80-
--------------------------------------------------------------------------------
81-
82-
Updated
83-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
84-
85-
#. Flask-Excel `issue 19 <https://github.com/pyexcel/Flask-Excel/issues/19>`_:
86-
sheet_name parameter to control sheet name
87-
#. use pyexcel v0.4.0
88-
89-
0.0.8 - 28.10.2016
90-
--------------------------------------------------------------------------------
91-
92-
Updated
93-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
94-
95-
#. use pyexcel v0.3.0
96-
97-
0.0.7 - 01.06.2016
98-
--------------------------------------------------------------------------------
99-
100-
Updated
101-
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
102-
103-
#. use pyexcel v0.2.2

‎LICENSE

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2015-2017 by Onni Software Ltd. and its contributors
1+
Copyright (c) 2015-2019 by Onni Software Ltd. and its contributors
22
All rights reserved.
33

44
Redistribution and use in source and binary forms of the software as well
@@ -13,7 +13,7 @@ that the following conditions are met:
1313
and/or other materials provided with the distribution.
1414

1515
* Neither the name of 'pyexcel-webio' nor the names of the contributors
16-
may not be used to endorse or promote products derived from this software
16+
may be used to endorse or promote products derived from this software
1717
without specific prior written permission.
1818

1919
THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND
@@ -27,4 +27,4 @@ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
2727
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
2828
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
2929
SOFTWARE AND DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
30-
DAMAGE.
30+
DAMAGE.

‎README.rst

+31-24
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,22 @@ pyexcel-webio - Let you focus on data, instead of file formats
33
================================================================================
44

55
.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png
6-
:target: https://www.patreon.com/pyexcel
6+
:target: https://www.patreon.com/chfw
77

8-
.. image:: https://api.travis-ci.org/pyexcel-webwares/pyexcel-webio.svg?branch=master
8+
.. image:: https://travis-ci.org/pyexcel-webwares/pyexcel-webio.svg?branch=master
99
:target: http://travis-ci.org/pyexcel-webwares/pyexcel-webio
1010

1111
.. image:: https://codecov.io/gh/pyexcel-webwares/pyexcel-webio/branch/master/graph/badge.svg
1212
:target: https://codecov.io/gh/pyexcel-webwares/pyexcel-webio
1313

14+
.. image:: https://badge.fury.io/py/pyexcel-webio.svg
15+
:target: https://pypi.org/project/pyexcel-webio
16+
17+
18+
.. image:: https://pepy.tech/badge/pyexcel-webio/month
19+
:target: https://pepy.tech/project/pyexcel-webio/month
20+
21+
1422
.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
1523
:target: https://gitter.im/pyexcel/Lobby
1624

@@ -19,13 +27,16 @@ Support the project
1927
================================================================================
2028

2129
If your company has embedded pyexcel and its components into a revenue generating
22-
product, please `support me on patreon <https://www.patreon.com/bePatron?u=5537627>`_ to
23-
maintain the project and develop it further.
30+
product, please support me on `patreon <https://www.patreon.com/bePatron?u=5537627>`_
31+
or `bounty source <https://salt.bountysource.com/teams/chfw-pyexcel>`_ to maintain
32+
the project and develop it further.
2433

25-
If you are an individual, you are welcome to support me too on patreon and for however long
26-
you feel like. As a patreon, you will receive
34+
If you are an individual, you are welcome to support me too and for however long
35+
you feel like. As my backer, you will receive
2736
`early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>`_.
2837

38+
And your issues will get prioritized if you would like to become my patreon as `pyexcel pro user`.
39+
2940
With your financial support, I will be able to invest
3041
a little bit more time in coding, documentation and writing interesting posts.
3142

@@ -179,37 +190,33 @@ On Windows systems, please issue this command::
179190

180191
> test.bat
181192

182-
How to update test environment and update documentation
193+
194+
Before you commit
195+
------------------------------
196+
197+
Please run::
198+
199+
$ make format
200+
201+
so as to beautify your code otherwise travis-ci may fail your unit test.
202+
203+
204+
And make sure you would have run moban command
183205
---------------------------------------------------------
184206

185207
Additional steps are required:
186208

187209
#. pip install moban
188-
#. git clone https://github.com/moremoban/setupmobans.git # generic setup
189-
#. git clone https://github.com/pyexcel/pyexcel-commons.git commons
190210
#. make your changes in `.moban.d` directory, then issue command `moban`
211+
#. moban
191212

192-
What is pyexcel-commons
193-
---------------------------------
194-
195-
Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in `pyexcel-commons` project.
213+
otherwise travis-ci may also fail your unit test.
196214

197215
What is .moban.d
198216
---------------------------------
199217

200218
`.moban.d` stores the specific meta data for the library.
201219

202-
Acceptance criteria
203-
-------------------
204-
205-
#. Has Test cases written
206-
#. Has all code lines tested
207-
#. Passes all Travis CI builds
208-
#. Has fair amount of documentation if your change is complex
209-
#. Please update CHANGELOG.rst
210-
#. Please add yourself to CONTRIBUTORS.rst
211-
#. Agree on NEW BSD License for your contribution
212-
213220

214221

215222
License

0 commit comments

Comments
 (0)