Skip to content

Commit 3e21465

Browse files
committed
kick start 0.1.0
1 parent 99f141a commit 3e21465

File tree

7 files changed

+75
-36
lines changed

7 files changed

+75
-36
lines changed

.travis.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,21 @@ language: python
33
notifications:
44
email: false
55
python:
6+
- pypy
67
- 3.6
78
- 3.5
89
- 3.4
910
- 3.3
1011
- 2.7
1112
- 2.6
12-
- pypy
1313
before_install:
14+
- cd $HOME
15+
- "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"
16+
- cd -
1417
- if [[ $TRAVIS_PYTHON_VERSION == "2.6" ]]; then pip install flake8==2.6.2; fi
1518
- if [[ -f min_requirements.txt && "$MINREQ" -eq 1 ]]; then
1619
mv min_requirements.txt requirements.txt ;
1720
fi
18-
- pip install --upgrade setuptools "pip==7.1"
1921
- test ! -f rnd_requirements.txt || pip install --no-deps -r rnd_requirements.txt
2022
- test ! -f rnd_requirements.txt || pip install -r rnd_requirements.txt ;
2123
- pip install -r tests/requirements.txt

CHANGELOG.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
Change log
22
================================================================================
33

4+
0.1.0 - unreleased
5+
--------------------------------------------------------------------------------
6+
7+
Added
8+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
9+
10+
#. To bring iget_array, iget_records, isave_as and isave_book_as to web clients
11+
#. To facilitate the use of pyexcel-handsontable, pyexcel-pygal
12+
413
0.0.11 - 04.03.2017
514
--------------------------------------------------------------------------------
615

README.rst

Lines changed: 53 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ pyexcel-webio - Let you focus on data, instead of file formats
1111
.. image:: https://codecov.io/github/pyexcel/pyexcel-webio/coverage.png
1212
:target: https://codecov.io/github/pyexcel/pyexcel-webio
1313

14-
.. image:: https://readthedocs.org/projects/pyexcel-webio/badge/?version=latest
15-
:target: http://pyexcel-webio.readthedocs.org/en/latest/
14+
.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
15+
:target: https://gitter.im/pyexcel/Lobby
16+
1617

1718
Known constraints
1819
==================
@@ -36,7 +37,7 @@ or clone it and install it:
3637

3738
.. code-block:: bash
3839
39-
$ git clone http://github.com/pyexcel/pyexcel-webio.git
40+
$ git clone https://github.com/pyexcel/pyexcel-webio.git
4041
$ cd pyexcel-webio
4142
$ python setup.py install
4243
@@ -118,6 +119,21 @@ This small section outlines the steps to adapt **pyexcel-webio** for your favour
118119
make_response_from_book_dict
119120
)
120121

122+
Support the project
123+
================================================================================
124+
125+
If your company has embedded pyexcel and its components into a revenue generating
126+
product, please `support me on patreon <https://www.patreon.com/bePatron?u=5537627>`_ to
127+
maintain the project and develop it further.
128+
129+
If you are an individual, you are welcome to support me too on patreon and for however long
130+
you feel like to. As a patreon, you will receive
131+
`early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>`_.
132+
133+
With your financial support, I will be able to invest
134+
a little bit more time in coding, documentation and writing interesting posts.
135+
136+
121137
Development guide
122138
================================================================================
123139

@@ -136,19 +152,39 @@ Then install relevant development requirements:
136152
#. pip install -r requirements.txt
137153
#. pip install -r tests/requirements.txt
138154

155+
Once you have finished your changes, please provide test case(s), relevant documentation
156+
and update CHANGELOG.rst.
157+
158+
.. note::
159+
160+
As to rnd_requirements.txt, usually, it is created when a dependent
161+
library is not released. Once the dependecy is installed
162+
(will be released), the future
163+
version of the dependency in the requirements.txt will be valid.
139164

140-
In order to update test environment, and documentation, additional steps are
141-
required:
165+
166+
How to test your contribution
167+
------------------------------
168+
169+
Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.
170+
171+
On Linux/Unix systems, please launch your tests like this::
172+
173+
$ make
174+
175+
On Windows systems, please issue this command::
176+
177+
> test.bat
178+
179+
How to update test environment and update documentation
180+
---------------------------------------------------------
181+
182+
Additional steps are required:
142183

143184
#. pip install moban
144185
#. git clone https://github.com/pyexcel/pyexcel-commons.git commons
145186
#. make your changes in `.moban.d` directory, then issue command `moban`
146187

147-
What is rnd_requirements.txt
148-
-------------------------------
149-
150-
Usually, it is created when a dependent library is not released. Once the dependecy is installed(will be released), the future version of the dependency in the requirements.txt will be valid.
151-
152188
What is pyexcel-commons
153189
---------------------------------
154190

@@ -159,28 +195,18 @@ What is .moban.d
159195

160196
`.moban.d` stores the specific meta data for the library.
161197

162-
How to test your contribution
163-
------------------------------
164-
165-
Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.
166-
167-
On Linux/Unix systems, please launch your tests like this::
168-
169-
$ make
198+
Acceptance criteria
199+
-------------------
170200

171-
On Windows systems, please issue this command::
201+
#. Has Test cases written
202+
#. Has all code lines tested
203+
#. Passes all Travis CI builds
204+
#. Has fair amount of documentation if your change is complex
205+
#. Agree on NEW BSD License for your contribution
172206

173-
> test.bat
174207

175208

176209
License
177210
================================================================================
178211

179212
New BSD License
180-
181-
Support the project
182-
================================================================================
183-
184-
If your company has embedded pyexcel and its components into a revenue generating
185-
product, please `support me on patreon <https://www.patreon.com/pyexcel>`_ to
186-
maintain the project and develop it further.

docs/source/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
]
1212

1313
intersphinx_mapping = {
14-
'pyexcel': ('http://pyexcel.readthedocs.org/en/latest/', None)
14+
'pyexcel': ('http://pyexcel.readthedocs.org/en/latest/', None),
1515
}
1616
spelling_word_list_filename = 'spelling_wordlist.txt'
1717
templates_path = ['_templates']
@@ -20,8 +20,8 @@
2020

2121
project = u'pyexcel-webio'
2222
copyright = u'2015-2017 Onni Software Ltd.'
23-
version = '0.0.10'
24-
release = '0.0.11'
23+
version = '0.0.11'
24+
release = '0.1.0'
2525
exclude_patterns = []
2626
pygments_style = 'sphinx'
2727
html_theme = 'default'

pyexcel_webio.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
overrides: "pyexcel.yaml"
22
name: "pyexcel-webio"
33
nick_name: webio
4-
version: 0.0.11
5-
release: 0.0.10
4+
version: "0.1.0"
5+
current_version: "0.1.0"
6+
release: "0.0.11"
67
dependencies:
78
- pyexcel>=0.4.0
89
description:

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77

88
NAME = 'pyexcel-webio'
99
AUTHOR = 'C.W.'
10-
VERSION = '0.0.11'
11-
EMAIL = 'wangc_2011 (at) hotmail.com'
10+
VERSION = '0.1.0'
11+
EMAIL = 'wangc_2011@hotmail.com'
1212
LICENSE = 'New BSD'
1313
DESCRIPTION = (
1414
'A generic request and response interface for pyexcel web extensions.' +

tests/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
nose
2+
mock;python_version<"3"
23
codecov
34
coverage
45
flake8

0 commit comments

Comments
 (0)