Metadata-Version: 2.1
Name: flake8-fine-pytest
Version: 0.0.1
Summary: A flake8 extension that checks test extra style
Home-page: https://github.com/best-doctor/flake8-fine-pytest
Author: BestDoctor
Author-email: khkaterine@gmail.com
License: MIT
Description: # flake8-fine-pytest
        
        [![Build Status](https://travis-ci.org/best-doctor/flake8-fine-pytest.svg?branch=master)](https://travis-ci.org/best-doctor/flake8-fine-pytest)
        [![Maintainability](https://api.codeclimate.com/v1/badges/ea5c318a4508b00d7be2/maintainability)](https://codeclimate.com/github/best-doctor/flake8-fine-pytest/maintainability)
        [![Test Coverage](https://api.codeclimate.com/v1/badges/ea5c318a4508b00d7be2/test_coverage)](https://codeclimate.com/github/best-doctor/flake8-fine-pytest/test_coverage)
        
        An extension for flake8 that validates tests structure, extra style and readability.
        
        Right now our checker:
        1) validates existence of reason in
        
        ```python
        @pytest.mark.xfail(reason='Super annoying test, fix it later')
        ```
        
        It helps everyone easily understand what was the problem in the first place
        and reduces amount of time wasted on fixing xfailed tests.
        
        ## Installation
        
        ```terminal
        pip install flake8-fine-pytest
        ```
        
        ## Example
        
        Sample file:
        
        ```python
        # test.py
        
        @pytest.mark.xfail(reason='')
        def test_xfail() -> None:
            pass
        
        @pytest.mark.xfail
        def test_xfail() -> None:
            pass
        ```
        
        Usage:
        
        ```terminal
        $ flake8 test.py
        test.py:1:1: FP001 xfailed test with empty reason
        test.py:5:1: FP002 xfailed test without reason
        ```
        
        ## Contributing
        
        We would love you to contribute to our project. It's simple:
        
        1. Create an issue with bug you found or proposal you have.
           Wait for approve from maintainer.
        1. Create a pull request. Make sure all checks are green.
        1. Fix review comments if any.
        1. Be awesome.
        
        Here are useful tips:
        
        - You can run all checks and tests with `make check`.
          Please do it before TravisCI does.
        - We use [BestDoctor python styleguide](https://github.com/best-doctor/guides/blob/master/guides/python_styleguide.md).
          Sorry, styleguide is available only in Russian for now.
        - We respect [Django CoC](https://www.djangoproject.com/conduct/).
          Make soft, not bullshit.
        
Keywords: flake8 pytest
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Framework :: Flake8
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
