Skip to content

Commit f002daf

Browse files
committed
update documentations
1 parent 82cd3d8 commit f002daf

File tree

6 files changed

+34
-24
lines changed

6 files changed

+34
-24
lines changed

.gitignore

+6-2
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,11 @@ ENV/
8989

9090
# Rope project settings
9191
.ropeproject
92+
93+
# emacs
9294
*~
93-
commons/
94-
commons
95+
96+
# moban hashes
9597
.moban.hashes
98+
.DS_store
99+

.moban.d/setup.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{%extends "setup.py.jj2"%}
1+
{%extends "pyexcel-setup.py.jj2"%}
22

33
{%block platform_block%}
4-
{%endblock%}
4+
{%endblock%}

.moban.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@ configuration:
22
configuration_dir: "commons/config"
33
template_dir:
44
- "commons/templates"
5+
- "setupmobans/templates"
56
- ".moban.d"
67
configuration: pyexcel-pygal.yml
78
targets:
89
- README.rst: README.rst
910
- setup.py: setup.py
1011
- requirements.txt: requirements.txt
11-
- LICENSE: LICENSE.jj2
12-
- MANIFEST.in: MANIFEST.in.jj2
12+
- LICENSE: NEW_BSD_LICENSE.jj2
1313
- "tests/requirements.txt": "tests/requirements.txt"
14-
- test.sh: test.sh.jj2
15-
- test.bat: test.sh.jj2
14+
- test.sh: test.script.jj2
15+
- test.bat: test.script.jj2
1616
- .travis.yml: travis.yml
17-
- .gitignore: .gitignore.jj2
17+
- .gitignore: gitignore.jj2
1818
- "docs/source/conf.py": "docs/source/conf.py"
1919
- "docs/source/index.rst": "docs/source/index.rst.jj2"

.travis.yml

-3
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ python:
1010
- 3.3
1111
- 2.7
1212
before_install:
13-
- cd $HOME
14-
- "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"
15-
- cd -
1613
- if [[ $TRAVIS_PYTHON_VERSION == "2.7" ]]; then pip install ipython==5.4; fi
1714
- if [[ $TRAVIS_PYTHON_VERSION == "pypy" ]]; then pip install ipython==5.4; fi
1815
- if [[ $TRAVIS_PYTHON_VERSION == "2.6" ]]; then pip install flake8==2.6.2; fi

README.rst

+8-6
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ pyexcel-pygal - Let you focus on presentation with pygal
88
.. image:: https://api.travis-ci.org/pyexcel/pyexcel-pygal.svg?branch=master
99
:target: http://travis-ci.org/pyexcel/pyexcel-pygal
1010

11-
.. image:: https://codecov.io/github/pyexcel/pyexcel-pygal/coverage.png
12-
:target: https://codecov.io/github/pyexcel/pyexcel-pygal
11+
.. image:: https://codecov.io/gh/pyexcel/pyexcel-pygal/branch/master/graph/badge.svg
12+
:target: https://codecov.io/gh/pyexcel/pyexcel-pygal
1313

1414
.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
1515
:target: https://gitter.im/pyexcel/Lobby
@@ -85,9 +85,9 @@ and update CHANGELOG.rst.
8585
.. note::
8686

8787
As to rnd_requirements.txt, usually, it is created when a dependent
88-
library is not released. Once the dependecy is installed
89-
(will be released), the future
90-
version of the dependency in the requirements.txt will be valid.
88+
library is not released. Once the dependecy is installed
89+
(will be released), the future
90+
version of the dependency in the requirements.txt will be valid.
9191

9292

9393
How to test your contribution
@@ -109,6 +109,7 @@ How to update test environment and update documentation
109109
Additional steps are required:
110110

111111
#. pip install moban
112+
#. git clone https://github.com/moremoban/setupmobans.git # generic setup
112113
#. git clone https://github.com/pyexcel/pyexcel-commons.git commons
113114
#. make your changes in `.moban.d` directory, then issue command `moban`
114115

@@ -129,11 +130,12 @@ Acceptance criteria
129130
#. Has all code lines tested
130131
#. Passes all Travis CI builds
131132
#. Has fair amount of documentation if your change is complex
133+
#. Please update CHANGELOG.rst
134+
#. Please add yourself to CONTRIBUTORS.rst
132135
#. Agree on NEW BSD License for your contribution
133136

134137

135138

136-
137139
License
138140
================================================================================
139141

setup.py

+13-6
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,26 @@
1717
'draw simple svg chart via pygal' +
1818
''
1919
)
20+
URL = 'https://github.com/pyexcel/pyexcel-pygal'
21+
DOWNLOAD_URL = '%s/archive/0.0.1.tar.gz' % URL
22+
FILES = ['README.rst', 'CHANGELOG.rst']
2023
KEYWORDS = [
21-
'excel',
22-
'python',
23-
'pyexcel',
24+
'python'
2425
]
2526

2627
CLASSIFIERS = [
2728
'Topic :: Office/Business',
2829
'Topic :: Utilities',
2930
'Topic :: Software Development :: Libraries',
3031
'Programming Language :: Python',
31-
'License :: OSI Approved :: BSD License',
3232
'Intended Audience :: Developers',
3333
'Programming Language :: Python :: 2.6',
3434
'Programming Language :: Python :: 2.7',
3535
'Programming Language :: Python :: 3.3',
3636
'Programming Language :: Python :: 3.4',
3737
'Programming Language :: Python :: 3.5',
3838
'Programming Language :: Python :: 3.6',
39+
'License :: OSI Approved :: BSD License',
3940
]
4041

4142
INSTALL_REQUIRES = [
@@ -82,7 +83,11 @@ def filter_out_test_code(file_handle):
8283
found_test_code = False
8384
yield line
8485
else:
85-
yield line
86+
for keyword in ['|version|', '|today|']:
87+
if keyword in line:
88+
break
89+
else:
90+
yield line
8691

8792

8893
if __name__ == '__main__':
@@ -92,7 +97,9 @@ def filter_out_test_code(file_handle):
9297
version=VERSION,
9398
author_email=EMAIL,
9499
description=DESCRIPTION,
95-
long_description=read_files('README.rst', 'CHANGELOG.rst'),
100+
url=URL,
101+
download_url=DOWNLOAD_URL,
102+
long_description=read_files(*FILES),
96103
license=LICENSE,
97104
keywords=KEYWORDS,
98105
extras_require=EXTRAS_REQUIRE,

0 commit comments

Comments
 (0)