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.4.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

flake8_pydocstyle-0.2.4-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flake8_pydocstyle-0.2.4.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.12.1 Windows/11

File hashes

Hashes for flake8_pydocstyle-0.2.4.tar.gz
Algorithm Hash digest
SHA256 0786aef71d6ecb942bfcf789dd7d659bebfd0e0bc13a061b699e4896be80a18c
MD5 6ae6f083a64b92a8790acccd05986d0d
BLAKE2b-256 68f0bb8e26824a6ae33b483a689c0ffef5a3201ce6ef86344267fa578015eba5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flake8_pydocstyle-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a2febaeb70f50a21dcfefcc6c6935561632653498fea2438ca26e78917351155
MD5 8360395db443f4691ba212d7a535a0ac
BLAKE2b-256 b2e15bb627c4c15156562dbd400e4ae26ee926c38705383358a207e78a8ed665

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