Metadata-Version: 2.1
Name: blue-chip
Version: 0.0.2
Summary: blue_chip
Home-page: https://github.com/Kilo59/blue-chip
License: UNKNOWN
Author: Gabriel Gore
Author-email: gabriel59kg@gmail.com
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Development Status :: 2 - Pre-Alpha
Requires-Dist: black
Requires-Dist: invoke
Requires-Dist: prospector[with_pyroma]

[![PyPI version](https://badge.fury.io/py/blue-chip.svg)](https://badge.fury.io/py/blue-chip)
[![Build Status](https://travis-ci.com/Kilo59/blue-chip.svg?branch=master)](https://travis-ci.com/Kilo59/blue-chip)
[![Coverage Status](https://coveralls.io/repos/github/Kilo59/blue-chip/badge.svg?branch=master)](https://coveralls.io/github/Kilo59/blue-chip?branch=master)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

# blue-chip
One click Python code quality package

`blue-chip` uses [`black`](https://github.com/ambv/black), [`invoke`](http://www.pyinvoke.org/) and [`prospector`](https://prospector.readthedocs.io/en/master/) configured to work well together out of the box.

-----------------------
## Install

The recommended installation method is to use [`pipx`](https://github.com/pipxproject/pipx)
```
pipx install blue-chip
```
Or use `pip`
```
pip install blue-chip --user
```

## Command-line use

List the possible `blue-chip` commands with `bc --list`
```
$bc --list

Subcommands:

  fmt    Format python source code.
  lint   Run static analysis on python source code.
```

----------------------

## Enterprise use
Enterprise teams may find it useful to fork and redistribute this package with their own custom defined standards.


In many cases this is a simple as changing the package name and values in [`blue_chip/constants.py`](https://github.com/Kilo59/blue-chip/blob/master/blue_chip/constants.py).

For fine grain control of the static analysis tools, edit the `prospector` profiles in [`blue_chip/lint_config`](https://github.com/Kilo59/blue-chip/blob/master/blue_chip/lint_config).

