Skip to content
This repository was archived by the owner on Jun 28, 2023. It is now read-only.

Commit fa06625

Browse files
committed
Update README
1 parent 9f86c9c commit fa06625

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

README.rst

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,34 @@ python-everywhere
1212
|pypi-dm|
1313
|pypi-dd|
1414
|gitter|
15+
|code-climate|
1516

1617

18+
This is a sample to help you with
19+
integrating services into your Python project !
20+
1721
Inspired by `rust-everywhere <https://github.com/japaric/rust-everywhere>`_.
1822

1923

24+
.. contents:: Table of Contents
25+
26+
27+
28+
Features
29+
========================================
30+
31+
* Travis CI integration
32+
* pytest integration for testing
33+
* flake8 integration (invoke by pytest)
34+
* pylint integration (invoke by pytest)
35+
* coverage integration (invoke by pytest)
36+
* pydocstyle integration
37+
* mypy integration (optional static type checker)
38+
* Publish to PyPI with Travis CI automatically (when tagging new release)
39+
* Publish to GitHub with Travis CI automatically (when tagging new release)
40+
41+
42+
2043
Installation
2144
========================================
2245

@@ -51,6 +74,15 @@ run your test code :
5174
Here is the pytest's `documetation <https://pytest.org/latest/goodpractices.html#integrating-with-setuptools-python-setup-py-test-pytest-runner>`_ about integrating with setuptools.
5275

5376

77+
Coverage
78+
------------------------------
79+
80+
With ``coverage``, we can generate testing coverage report.
81+
With ``pytest-cov`` and
82+
``--cov-report html`` ``--cov-report term`` in the ``pytest.ini``,
83+
we can generate testing coverage report along with running testing code.
84+
85+
5486
Coveralls
5587
------------------------------
5688

@@ -95,16 +127,22 @@ Please visit ``https://travis-ci.org/profile/USERNAME``
95127
to open Travis CI support for your repo.
96128

97129

98-
Gitter
130+
Comunication
99131
========================================
100132

133+
Gitter
134+
------------------------------
135+
101136
Please visit ``https://gitter.im/USERNAME#createroom``
102137
to add chat room for your repo.
103138

104139

105-
Code Climate
140+
Code Review
106141
========================================
107142

143+
Code Climate
144+
------------------------------
145+
108146
Please visit ``https://codeclimate.com/github/signup``
109147
to add automated code review for your repo.
110148

@@ -140,3 +178,6 @@ to add automated code review for your repo.
140178

141179
.. |license| image:: https://img.shields.io/github/license/wdv4758h/python-everywhere.svg
142180
:target: https://github.com/wdv4758h/python-everywhere/blob/master/LICENSE
181+
182+
.. |code-climate| image:: https://img.shields.io/codeclimate/github/wdv4758h/python-everywhere.svg
183+
:target: https://codeclimate.com/github/wdv4758h/python-everywhere

0 commit comments

Comments
 (0)