update README and add CHANGELOG

Author: reverbc

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## [Unreleased]
+### Fixed
+- Fix fixtures defined with `@pytest.yield_fixture` decorator still showing FP
+
+## [0.1.1] - 2020-05-19
+### Fixed
+- Fix crashes when `*args` or `**kwargs` is used in FuncDef
+
+## [0.1] - 2020-05-18
+### Added
+- Suppressing FP `unused-import` with tests
+- Suppressing FP `unused-argument` with tests
+- Suppressing FP `redefined-outer-scope` with tests
+- Add CI/CD configuration with Travis CI

README.md

@@ -1,9 +1,17 @@
 # pylint-pytest
 
-A Pylint plugin to suppress false positive pylint warnings about pytest fixtures.
+[![PyPI version fury.io](https://badge.fury.io/py/pylint-pytest.svg)](https://pypi.python.org/pypi/pylint-pytest/)
+[![Travis CI](https://travis-ci.org/reverbc/pylint-pytest.svg?branch=master)](https://travis-ci.org/reverbc/pylint-pytest)
+
+A Pylint plugin to suppress pytest-related false positives.
 
 ## Installation
 
+Requirements:
+
+- `pylint`
+- `pytest>=4.6`
+
 To install:
 
 ```bash
@@ -12,27 +20,55 @@ $ pip install pylint-pytest
 
 ## Usage
 
+Enable via command line option `--load-plugins`
+
 ```bash
 $ pylint --load-plugins pylint_pytest <path_to_your_sources>
 ```
 
-Or
+Or in `pylintrc`:
+
+```ini
+[MASTER]
+load-plugins=pylint_pytest
+```
 
 ## Suppressed Pylint Warnings
 
 ### `unused-argument`
 
+FP when a fixture is used in an applicable function but not referenced in the function body, e.g.
 
+```python
+def test_something(conftest_fixture):  # <- Unused argument 'conftest_fixture'
+    assert True
+```
 
 ### `unused-import`
 
+FP when an imported fixture is used in an applicable function, e.g.
+
+```python
+from fixture_collections import imported_fixture  # <- Unused imported_fixture imported from fixture_collections
+
+def test_something(imported_fixture):
+    ...
+```
 
 ### `redefined-outer-name`
 
+FP when an imported/declared fixture is used in an applicable function, e.g.
+
+```python
+from fixture_collections import imported_fixture
+
+def test_something(imported_fixture):  # <- Redefining name 'imported_fixture' from outer scope (line 1)
+    ...
+```
 
-## Tests
+## Changelog
 
-TBD
+See [CHANGELOG](CHANGELOG.md).
 
 ## License
 

setup.py

@@ -1,9 +1,15 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+from os import path
 from setuptools import setup
 
 
+here = path.abspath(path.dirname(__file__))
+with open(path.join(here, 'README.md')) as fin:
+    long_description = fin.read()
+
+
 setup(
     name='pylint-pytest',
     version='0.1.1',
@@ -13,7 +19,9 @@
     maintainer_email='[email protected]',
     license='MIT',
     url='https://github.com/reverbc/pylint-pytest',
-    description='A Pylint plugin to suppress pytest fixture related false positive warnings.',
+    description='A Pylint plugin to suppress pytest-related false positives.',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     py_modules=['pylint_pytest'],
     install_requires=[
         'pylint',