Allow running docstring checks via pydocstyle

[StanczakDominik]

There's another package by the PyCQA called pydocstyle, which does basically the same thing as pycodestyle, except for docstrings. Unfortunately, it doesn't offer fixing bugs by itself, but it seems like it could potentially be a worthy addition to pep8speaks. Would you be interested in an implementation proposal (via PR)?

There's some more discussion started over at my main project ( PlasmaPy/PlasmaPy#276 where we considered running pydocstyle as a CI service).

[OrkoHunter]

Hello @StanczakDominik

Thank you so much for using PEP8Speaks and considering to suggest an improvement. I am +1 for running pydocstyle. However, since they are not in "PEP8", let us keep the default option, not to check the docs, while it can be enabled by a configuration from .pep8speaks.yml.

Feel free to go ahead and work on this. I shall nevertheless consider working on this in the upcoming month sometime.

[StanczakDominik]

All right! I'm starting to look through the code and tentatively make changes. I'm not too sure what the best way to test this out would be, but I guess I can probably mock some data and see how it behaves.

[OrkoHunter]

@StanczakDominik Testing is definitely a pain in here. The way I do it is

1. Deploy the code on a new herokuapp.
2. Create a test repository with payload URL as this herokuapp.
3. Create PRs on this test repository and see the responses.

That's quite a load of manual work. :(

[nijel]

How about supporting this through flake8 extensions? There is flake8-docstrings. Also having support for flake8 extensions would make this tool generally extensible.

So in the end this might be obsoleted once #56 is implemented.