Skip to content

Commit 2045e98

Browse files
author
Sergey Vilgelm
committed
update the REAME.md
1 parent 8031a75 commit 2045e98

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# pylint-file-header
22

3-
[![Pypi](https://img.shields.io/pypi/v/pylintfileheader.svg?style=flat-square)](https://pypi.python.org/pypi/pylintfileheader) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pylintfileheader.svg?style=flat-square)](https://pypi.python.org/pypi/pylintfileheader) [![PyPI - Downloads](https://img.shields.io/pypi/dm/pylintfileheader.svg?style=flat-square)](https://pypistats.org/packages/pylintfileheader) [![Stars](https://img.shields.io/github/stars/HaaLeo/pylint-file-header.svg?label=Stars&logo=github&style=flat-square)](https://github.com/HaaLeo/pylint-file-header/stargazers)
4-
[![PyPI - License](https://img.shields.io/pypi/l/pylintfileheader.svg?style=flat-square)](https://raw.githubusercontent.com/HaaLeo/pylint-file-header/master/LICENSE.txt) [![Build Status](https://img.shields.io/travis/HaaLeo/pylint-file-header/master.svg?style=flat-square)](https://travis-ci.org/HaaLeo/pylint-file-header) [![Codecov](https://img.shields.io/codecov/c/github/HaaLeo/pylint-file-header.svg?style=flat-square)](https://codecov.io/gh/HaaLeo/pylint-file-header) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
3+
[![Pypi](https://img.shields.io/pypi/v/pylintfileheader.svg?style=flat-square)](https://pypi.python.org/pypi/pylintfileheader) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pylintfileheader.svg?style=flat-square)](https://pypi.python.org/pypi/pylintfileheader) [![PyPI - Downloads](https://img.shields.io/pypi/dm/pylintfileheader.svg?style=flat-square)](https://pypistats.org/packages/pylintfileheader) [![Stars](https://img.shields.io/github/stars/HaaLeo/pylint-file-header.svg?label=Stars&logo=github&style=flat-square)](https://github.com/HaaLeo/pylint-file-header/stargazers)
4+
[![PyPI - License](https://img.shields.io/pypi/l/pylintfileheader.svg?style=flat-square)](https://raw.githubusercontent.com/HaaLeo/pylint-file-header/master/LICENSE.txt) [![Build Status](https://img.shields.io/travis/HaaLeo/pylint-file-header/master.svg?style=flat-square)](https://travis-ci.org/HaaLeo/pylint-file-header) [![Codecov](https://img.shields.io/codecov/c/github/HaaLeo/pylint-file-header.svg?style=flat-square)](https://codecov.io/gh/HaaLeo/pylint-file-header) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
55
[![Donate](https://img.shields.io/badge/-Donate-blue.svg?logo=paypal&style=flat-square)](https://www.paypal.me/LeoHanisch)
66

77
Pylint plugin to enforce consistent file/module header.
@@ -17,14 +17,16 @@ pip install pylintfileheader
1717
## Configuration
1818

1919
Generate a `.pylintrc` file by executing `pylint --generate-rcfile`.
20-
Then add `pylintfileheader` to the plugins to load and set the `file-header` option to the [regular expression](https://docs.python.org/3/library/re.html#regular-expression-syntax) that the file header should match.
20+
Then add `pylintfileheader` to the plugins to load and set the `file-header` option to the [regular expression](https://docs.python.org/3/library/re.html#regular-expression-syntax) that the file header should match.
2121
When the `file-header` setting is omitted, pylint will pass.
2222

23+
* `file-header-ignore-empty-files` turns on the mode of ignoring the empty files, like `__init__.py`. The default value is `False`.
24+
2325
## Example
2426

2527
### Setup
2628

27-
* **.pylintrc**:
29+
* **.pylintrc**:
2830

2931
```pylintrc
3032
[MASTER]
@@ -33,7 +35,7 @@ When the `file-header` setting is omitted, pylint will pass.
3335
file-header=# -----------\n#[ \w]*\n# -----------
3436
```
3537

36-
* **valid_example.py**:
38+
* **valid_example.py**:
3739

3840
```python
3941
# -----------
@@ -43,7 +45,7 @@ When the `file-header` setting is omitted, pylint will pass.
4345
print('I am a valid example')
4446
```
4547

46-
* **invalid_example.py**:
48+
* **invalid_example.py**:
4749

4850
```python
4951
# lorem ipsum
@@ -53,15 +55,15 @@ When the `file-header` setting is omitted, pylint will pass.
5355

5456
### Evaluation
5557

56-
* `pylint valid_example.py` evaluates to:
58+
* `pylint valid_example.py` evaluates to:
5759
```
5860
Using config file /path/to/your/.pylintrc
5961
6062
------------------------------------
6163
Your code has been rated at 10.00/10
6264
```
6365

64-
* `pylint invalid_example.py` evaluates to:
66+
* `pylint invalid_example.py` evaluates to:
6567
```
6668
Using config file /path/to/your/.pylintrc
6769
************* Module invalid_example
@@ -73,10 +75,10 @@ When the `file-header` setting is omitted, pylint will pass.
7375

7476
## Contribution
7577

76-
If you found a bug or are missing a feature do not hesitate to [file an issue](https://github.com/HaaLeo/pylint-file-header/issues/new/choose).
78+
If you found a bug or are missing a feature do not hesitate to [file an issue](https://github.com/HaaLeo/pylint-file-header/issues/new/choose).
7779
Pull Requests are welcome!
7880

7981
## Support
8082

81-
When you like this package make sure to [star the repository](https://github.com/HaaLeo/pylint-file-header/stargazers). I am always looking for new ideas and feedback.
83+
When you like this package make sure to [star the repository](https://github.com/HaaLeo/pylint-file-header/stargazers). I am always looking for new ideas and feedback.
8284
In addition, it is possible to [donate via paypal](https://www.paypal.me/LeoHanisch).

0 commit comments

Comments
 (0)