Skip to main content

flake8 plugin that integrates pydocstyle

Project description

license

latest release latest release date

PyPI version Python

flake8-pydocstyle

Plugin for flake8 that runs pydocstyle while linting.

It is running pydocstyle as it would be run without any parameters in the command line, so it respects all configuration file options that you can set for example in pyproject.toml.

Reason

Maybe you ask a question why just not use flake8-docstrings. In my use-case I wanted to keep the configuration in the pyproject.toml file and be able to use everything that pydocstyle has to offer in terms of customization. The flake8-docstrings is not reading the pydocstyle config files, but provides its own options which was insufficient to me.

Contributing

If you wish to contribute feel free to create an issue or just straight away fork and create PR to this repository. To save your and my time on discussions please provide a good description for them.

Development

Development documentation can be found here

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flake8_pydocstyle-0.2.1.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

flake8_pydocstyle-0.2.1-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file flake8_pydocstyle-0.2.1.tar.gz.

File metadata

  • Download URL: flake8_pydocstyle-0.2.1.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.11.0 Windows/10

File hashes

Hashes for flake8_pydocstyle-0.2.1.tar.gz
Algorithm Hash digest
SHA256 ee2ca920773caf765cc5116f913b882f381cc6f8aeef1605130269f2f22f5f09
MD5 0e8de7e7b1a4ce0eddcf782a4bf86f57
BLAKE2b-256 9d84f5fbdffd0d17cb45f939e084e9fb68d39f570011ba3fac6a27321cee8b66

See more details on using hashes here.

File details

Details for the file flake8_pydocstyle-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for flake8_pydocstyle-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 581c1d32ffb42bd8ab81ba456e0a94def4fb0cea7470ee912b89569e0e2705a2
MD5 e9b0d3b60c5bac2dbb1c5b15e06073c8
BLAKE2b-256 ff32b5b198cc158e4aada9d111d35a6400d22d0f87d4804c482c25691cf437fd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page