Skip to content

Commit d55d840

Browse files
chfwchfw
committed
📚 update readme
1 parent 76bca72 commit d55d840

File tree

4 files changed

+80
-1
lines changed

4 files changed

+80
-1
lines changed

‎CHANGELOG.rst

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

4+
0.0.12 - tbd
5+
--------------------------------------------------------------------------------
6+
7+
**added**
8+
9+
#. `#143 <https://github.com/moremoban/pypi-mobans/issues/143>`_: include python
10+
setup.py checkdocs
11+
412
0.0.11 - 03.05.2020
513
--------------------------------------------------------------------------------
614

@@ -17,6 +25,8 @@ Change log
1725
#. add python_requires in setup.py
1826
#. no code coverage support
1927
#. add github star badges
28+
#. `#145 <https://github.com/moremoban/pypi-mobans/issues/145>`_: specify test
29+
dependencies with project.yml file
2030

2131
**Fixed**
2232

‎README.rst

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,20 @@ pypi-mobans
1414

1515

1616
Scaffolding templates for your Python project.
17+
18+
19+
create a blank python package that is usable and ready to push to github. And future
20+
updates on your organisation's specific static information can be instantly applies the
21+
update accurately using `moban`_. Here is a list of features:
22+
23+
#. core python package
24+
#. test configuration setup
25+
#. ready to commit github repository
26+
#. automated upload to pypi through twine
27+
#. version management through jinja2
28+
#. automated github release through gease
29+
30+
1731
It is used with `yehua <https://github.com/chfw/yehua>`_.
1832
Organisations using it:
1933

@@ -25,6 +39,54 @@ Organisations using it:
2539
Features
2640
================================================================================
2741

42+
Feature comparision
43+
--------------------------------------------------------------------------------
44+
45+
The following table is a personal feature comparision. If you have a different
46+
opinion, especially you are the author of the following repository, please
47+
raise an issue and we can talk. This table is not a commerical sales pitch.
48+
49+
#. Y: have such a feature
50+
#. M: manual operation
51+
#. A: automatic operation
52+
53+
.. table:: Detailed feature comparision
54+
55+
============== ========================== ======================= ===================== ========== =====
56+
Group Feature cookiecutter-pypackage cookiecutter-vanguard PyScaffold yehua
57+
============== ========================== ======================= ===================== ========== =====
58+
essential setup.py Y Y Y Y
59+
. setup.cfg Y Y Y Y
60+
. source code stub Y Y Y Y
61+
test setup requirements.txt Y Y Y
62+
. requirements_dev.txt Y Y Y
63+
. Makefile Y Y
64+
. tests code Y Y Y
65+
. tox Y Y
66+
. travis Y Y Y
67+
. test coverage Y Y
68+
. flake8 Y
69+
documentation README.rst Y Y Y
70+
. labels Y
71+
. gitignore Y Y Y
72+
. AUTHORS.rst Y Y Y
73+
. CONTRIBUTING.rst Y Y
74+
. HISTORY.rst/CHANGELOG .rst Y Y Y Y
75+
. LICENCE Y Y Y Y
76+
. MANIFEST.in Y Y Y
77+
. sphinx docs Y Y Y Y
78+
usability interactive shell Y Y Y
79+
. one liner Y
80+
. initialize github repo Y
81+
maintenance publish on pypi A M M
82+
. dependency management M M A
83+
. template customization Y
84+
. version management M M A
85+
. automated github release Y
86+
. continous templating Y
87+
============== ========================== ======================= ===================== ========== =====
88+
89+
2890
setup.py
2991
----------
3092

‎changelog.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
name: pypi-mobans
22
organisation: moremoban
33
releases:
4+
- changes:
5+
- action: added
6+
details:
7+
- "`#143`: include python setup.py checkdocs"
8+
date: tbd
9+
version: 0.0.12
410
- changes:
511
- action: Updated
612
details:
@@ -14,6 +20,7 @@ releases:
1420
- "add python_requires in setup.py"
1521
- "no code coverage support"
1622
- "add github star badges"
23+
- "`#145`: specify test dependencies with project.yml file"
1724
- action: Fixed
1825
details:
1926
- "fixed travis config"

‎templates/test.script.jj2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
{%endif%}
2323
{%endif%}
2424
pip freeze
25-
nosetests --with-coverage --cover-package {{package|lower|replace('-', '_')}} --cover-package tests tests {%if include_doctest%}--with-doctest --doctest-extension=.rst README.rst{%endif%} {%if not nodocs%}docs/source{%endif%} {%if not external_module_library%}{{package|lower|replace('-', '_')}}{%endif%}
25+
nosetests --with-coverage --cover-package {{package|lower|replace('-', '_')}} --cover-package tests tests {%if include_doctest%}--with-doctest --doctest-extension=.rst {%if not skip_readme%}README.rst{%endif%}{%endif%} {%if not nodocs%}docs/source{%endif%} {%if not external_module_library%}{{package|lower|replace('-', '_')}}{%endif%}
2626

2727
{%block posttest%}
2828
{%endblock%}

0 commit comments

Comments
 (0)