Package: wemake-python-styleguide
wemake-python-styleguideWelcome to the strictest and most opinionated Python linter ever.wemake-python-styleguideis actually aflake8plugin withsome other pluginsas dependencies.Quickstartpipinstallwemake-python-styleguideYou will also need to create asetup.cfgfile with theconfiguration.Try it online!We highly recommend to also use:flakeheavenfor easy integration into alegacycodebasenitpickfor sharing and validating configuration across multiple projectsRunningflake8your_module.pyThis app is still just good oldflake8!
And it won't change your existing workflow.See"Usage" sectionin the docs for examples and integrations.We also supportGitHub Actionsas first class-citizens.Try it out!Strict is the new coolStrict linting offers the following benefits to developers and companies:Ensures consistency - no matter who works on it, the end product will always be the same dependable codeHelps avoid potential bugs - strict rules make sure that you don't make common mistakesEfficient code reviews - each piece of code has a similar familiar style and syntax. If it passes all the checks, there's little left to review!Fewer code revisions - strict linting ensures that you don't have to re-write the codebase again and againReduce code redundancy - Sometimes we write complex code as we are thinking in a certain way about a problem. The linter offers suggestions that can help simplify the code and eliminate redundant statementsWhat we are aboutThe ultimate goal of this project is
to make all people writeexactlythe samePythoncode.flake8pylintblackmypywemake-python-styleguideFormats code?❌❌✅❌❌Finds style issues?🤔✅🤔❌✅Finds bugs?🤔✅❌✅✅Finds complex code?❌🤔❌❌✅Has a lot of strict rules?❌🤔❌❌✅Has a lot of plugins?✅❌❌🤔✅We have several primary objectives:Enforcepython3.7+usageSignificantly reduce the complexity of your code and make it more maintainableEnforce "There should be one -- and preferably only one -- obvious way to do it" rule to coding and naming stylesProtect developers from possible errors and enforce best practicesYou can find all error codes and pluginsin the docs.What we are notWe arenotplanning to do the following things:Assume or check types, usemypytogether with our linterReformat code, since we believe that developers should do thatCheck forSyntaxErroror logical bugs, write tests insteadAppeal to everyone. But, you canswitch offany rules that you don't likeSupporting us :tada:We inwemake.servicesmake
all our tools open-source by default, so the community can benefit from them.
If you use our tools and they make your life easier and brings business value,
you can return us a favor by supporting the work we do.Show your style :sunglasses:If you use our linter - it means that your code is awesome.
You can be proud of it!
And you should share your accomplishment with others
by including a badge in yourREADMEfile. It looks like this:Markdown[![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](https://github.com/wemake-services/wemake-python-styleguide)Restructured text..image::https://img.shields.io/badge/style-wemake-000000.svg:target:https://github.com/wemake-services/wemake-python-styleguideContributingWewarmly welcomeall contributions!See"Contributing"section in the documentation if you want to contribute.You can start withissues that need some helpright now.