Metadata-Version: 2.1
Name: ni-python-styleguide
Version: 0.1.4
Summary: NI's internal and external Python linter rules and plugins
Home-page: https://github.com/ni/python-styleguide
License: MIT
Author: NI
Author-email: opensource@ni.com
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: black (>=20.8b1,<21.0)
Requires-Dist: click (>=7.1.2,<8.0.0)
Requires-Dist: flake8 (>=3.8.3,<4.0.0)
Requires-Dist: flake8-black (>=0.2.1,<0.3.0)
Requires-Dist: flake8-docstrings (>=1.5.0,<2.0.0)
Requires-Dist: pep8-naming (>=0.11.1,<0.12.0)
Requires-Dist: toml (>=0.10.1,<0.11.0)
Project-URL: Repository, https://github.com/ni/python-styleguide
Description-Content-Type: text/markdown

# NI Python Style Guide

![logo](docs/logo.svg)

---

<!-- @TODO: We should show you some stinkin' badges -->

Welcome to NI's internal and external Python conventions and enforcement tooling.

## Written Conventions

Our written conventions can be found at https://ni.github.io/python-styleguide/.

Their source is in [docs/Coding-Conventions.md](docs/Coding-Conventions.md).

NOTE: Using the GitHub Pages link is preferable to a GitHub `/blob` link.

## Enforcement tooling

As a tool, `ni-python-styleguide` is installed like any other script:

```bash
pip install ni-python-styleguide
```

### Linting

To lint, just run the `lint` subcommand:

```bash
ni-python-styleguide lint
# or
ni-python-styleguide lint ./dir/
# or
ni-python-styleguide lint module.py
```

The rules enforced are all rules documented in the written convention, which are marked as enforced.

### Formatting

(This section to come!)

### Editor Integration

(This section to come!)

