Metadata-Version: 2.1
Name: wemake-python-styleguide
Version: 0.1.0
Summary: The most opinionated linter ever, used by wemake.services
Home-page: https://wemake-python-styleguide.readthedocs.io
License: MIT
Keywords: flake8,flake8-plugin,linter,wemake.services,styleguide,code quality
Author: Nikita Sobolev
Author-email: mail@sobolevn.me
Requires-Python: >=3.6,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Framework :: Flake8
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Dist: attrs (>=18.2,<19.0)
Requires-Dist: flake8 (>=3.5,<4.0)
Requires-Dist: flake8-bandit (>=1.0,<2.0)
Requires-Dist: flake8-broken-line (>=0.1,<0.2)
Requires-Dist: flake8-bugbear (>=18.2,<19.0)
Requires-Dist: flake8-builtins (>=1.4,<2.0)
Requires-Dist: flake8-coding (>=1.3,<2.0)
Requires-Dist: flake8-commas (>=2.0,<3.0)
Requires-Dist: flake8-comprehensions (>=1.4,<2.0)
Requires-Dist: flake8-debugger (>=3.1,<4.0)
Requires-Dist: flake8-docstrings (>=1.3,<2.0)
Requires-Dist: flake8-eradicate (>=0.1,<0.2)
Requires-Dist: flake8-isort (>=2.5,<3.0)
Requires-Dist: flake8-logging-format (>=0.5,<0.6)
Requires-Dist: flake8-pep3101 (>=1.2,<2.0)
Requires-Dist: flake8-quotes (>=1.0,<2.0)
Requires-Dist: flake8-string-format (>=0.2,<0.3)
Requires-Dist: flake8-type-annotations (>=0.1,<0.2)
Requires-Dist: pep8-naming (>=0.7,<0.8)
Requires-Dist: pycodestyle (==2.3.1)
Description-Content-Type: text/markdown

# wemake-python-styleguide

[![wemake.services](https://img.shields.io/badge/-wemake.services-green.svg?label=%20&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC%2FxhBQAAAAFzUkdCAK7OHOkAAAAbUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAP%2F%2F%2F5TvxDIAAAAIdFJOUwAjRA8xXANAL%2Bv0SAAAADNJREFUGNNjYCAIOJjRBdBFWMkVQeGzcHAwksJnAPPZGOGAASzPzAEHEGVsLExQwE7YswCb7AFZSF3bbAAAAABJRU5ErkJggg%3D%3D)](https://wemake.services)
[![Build Status](https://travis-ci.org/wemake-services/wemake-python-styleguide.svg?branch=master)](https://travis-ci.org/wemake-services/wemake-python-styleguide)
[![Build status](https://ci.appveyor.com/api/projects/status/mpopx4wpfkrhc1sl?svg=true)](https://ci.appveyor.com/project/wemake-services/wemake-python-styleguide)
[![Coverage](https://coveralls.io/repos/github/wemake-services/wemake-python-styleguide/badge.svg?branch=master)](https://coveralls.io/github/wemake-services/wemake-python-styleguide?branch=master)
[![PyPI version](https://badge.fury.io/py/wemake-python-styleguide.svg)](https://badge.fury.io/py/wemake-python-styleguide)
[![Documentation Status](https://readthedocs.org/projects/wemake-python-styleguide/badge/?version=latest)](https://wemake-python-styleguide.readthedocs.io/en/latest/?badge=latest)
[![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/wemake-services/wemake-python-styleguide/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)

---

Welcome to the most opinionated linter ever.

`wemake-python-styleguide` is actually a `flake8` plugin
with some other plugins as dependencies.

```text
The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than *right* now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea -- let's do more of those!
```

## Installation

```bash
pip install wemake-python-styleguide
```

You will also need to create a `setup.cfg` file with [the following contents](https://wemake-python-styleguide.readthedocs.io/en/latest/_pages/options/config.html#third-party-plugins).

This file is required to configure our linter and 3rd party plugins it uses.
However, this is a temporary solution. 
We are working at providing the configuration for you in the future.


## What we are about

We have several primary objectives with this linter:

0. Enforce `python3.6+` usage
1. Significantly reduce code's complexity and make it more maintainable
2. Enforce "There should be one-- and preferably only one --obvious way to do it" rule
3. Create consistent coding and naming style

You can find all error codes and plugins [in the docs](https://wemake-python-styleguide.readthedocs.io/en/latest/_pages/errors/index.html).


## What we are not

We are here not to:

0. Assume or check types, use `mypy` instead
1. Reformat code, since we believe that developers should do that
2. Check for `SyntaxError`s or exceptions, write tests instead
3. Suite everyone, this is **our** linter


## Contributing

See [CONTRIBUTING.md](https://github.com/wemake-services/wemake-python-styleguide/blob/master/CONTRIBUTING.md) file if you want to contribute.
You can also check which [issues need some help](https://github.com/wemake-services/wemake-python-styleguide/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) right now.


## License

MIT. See [LICENSE](https://github.com/wemake-services/wemake-python-styleguide/blob/master/LICENSE) for more details.

