Skip to content

Commit 5c751f9

Browse files
committed
Update readme, docs, wiki, assets
1 parent d53bdf1 commit 5c751f9

File tree

16 files changed

+9
-2
lines changed

16 files changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Project status
1212
------------------------------------------------------------------------------
1313
![WIP](https://img.shields.io/badge/%20%F0%9F%9A%A7%20-Dev%20in%20progress-important)
1414
[![Maintainability](https://api.codeclimate.com/v1/badges/cc34f11b1a2b9bb8e216/maintainability)](https://codeclimate.com/github/pritam001/pyflask-microservice-base/maintainability)
15+
[![codecov](https://codecov.io/gh/pritam001/pyflask-microservice-base/branch/master/graph/badge.svg)](https://codecov.io/gh/pritam001/pyflask-microservice-base)
1516

1617

1718
Tools
@@ -26,6 +27,7 @@ Tools
2627
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat&logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
2728
[![API Specs](https://img.shields.io/badge/specs-flasgger-6D9A00?style=flat&logo=swagger&logoColor=white)](https://github.com/flasgger/flasgger)
2829
[![Tests: pytest](https://img.shields.io/badge/%20tests-pytest-%23009BDB?style=flat)](https://docs.pytest.org/en/latest/contents.html)
30+
[![Coverage: pytest-cov](https://img.shields.io/badge/%20coverage-pytest--cov-%23009BDB?style=flat)](https://docs.pytest.org/en/latest/contents.html)
2931

3032

3133
Usage Guide
@@ -50,9 +52,13 @@ Type `make help` for available commands
5052

5153
<p align="center"><img src="documentation/assets/make-help.gif" /></p>
5254

55+
Type `make pre-commit` before committing your changes to run formatters, linters, tests and code coverage collectors
56+
57+
<p align="center"><img src="documentation/assets/make-pre-commit.gif" /></p>
58+
5359

5460
### Linting Guide
55-
`make format` : Format and fix python code with black, isort, autoflake
61+
`make format` : Format and fix python code with black, isort, autoflake and pre-commit hooks
5662

5763
<p align="center"><img src="documentation/assets/make-format.gif" /></p>
5864

@@ -94,6 +100,7 @@ TODO
94100
- [ ] Update linting documentation
95101
- [x] Introduction of testing tools
96102
- [ ] Testing tools documentation
103+
- [x] Code coverage
97104
- [ ] Version handling by tbump
98-
- [ ] Add CoC, Contribution guidelines, PR and issue
105+
- [ ] Add CoC, Contribution guidelines, PR and issue templates
99106

555 KB
Loading

documentation/assets/make-help.gif

29.4 KB
Loading

documentation/assets/make-lint.gif

-515 KB
Loading
4.51 MB
Loading
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)