Skip to main content

A pytest plugin to enable format checking with black

Project description

pytest-black-ng

A pytest plugin to enable format checking with black.

This is a fork of the original pytest-black plugin by ShopKeep Inc to provide an up-to-date version of this plugin.

Requirements

There is a minimum requirement of black 22.1.0 or later.

Installation

$ pip install pytest-black-ng

Usage

To run pytest with formatting checks provided by black:

$ pytest --black

The plugin will output a diff of suggested formatting changes (if any exist). Changes will not be applied automatically.

Configuration

You can override default black configuration options by placing a pyproject.toml file in your project directory. See example configuration here.

Testing

To run the tests, simply run:

$ pytest
$ flake8

CI takes care of running this against a selecting of Python versions.

License

Distributed under the terms of the MIT license, pytest-black-ng is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-black-ng-0.4.1.tar.gz (6.4 kB view hashes)

Uploaded Source

Built Distribution

pytest_black_ng-0.4.1-py3-none-any.whl (4.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page