portray VS awesome-flake8-extensions

Sphinx along with MyST-parser to write documentation in markdown. I recently discovered portray which seems like a nice alternative as it supports markdown by default for both generic documentation and docstring in modules, class, methods and functions.

Ultimately we want to test our code with Flake8 and plugins to enforce a more consistent code style and to encourage best practices. When you first introduce flake8 or a new plug-in commonly you have a lot of violations that you can silence with a #noqa comment. When you first introduce a new flake8 plugin, you will likely have a lot of violations, which you silence with #noqa comments. Over time these comments will become obsolete because you fixed the. yesqa will automatically remove these unnecessary #noqa comments.

flake8 for linting along with following plugin (list of awesome plugin can be found here, but me and my teammates have selected the below one. Have linting but don't make it too hard.) flake8-black which uses black for code formatting check. flake8-isort which uses isort for separation of import in section and formatting them alphabetically. flake8-bandit which uses bandit for security linting. flake8-bugbear for finding likely bugs and design problems in your program. flake8-bugbear - Finding likely bugs and design problems in your program. pep8-naming for checking the PEP-8 naming conventions. mccabe for Ned’s script to check McCabe complexity flake8-comprehensions for writing better list/set/dict comprehensions.

In addition to this out of the box -linting, there are loads of flake8 extensions that can help you with for example switching from .format() to using f-strings or checking that your naming follows the PEP8 guidelines. For example, adding flake8-length adds line length checking to the linting.

And if you're using flake8, make sure to check out its plugins. Here's a good list: https://github.com/DmytroLitvinov/awesome-flake8-extensions