Skip to main content

flake8 plugin that integrates pydocstyle

Project description

license

latest release latest release date

PyPI version Python

flake8-pydocstyle

The project is ARCHIVED, and it is no longer actively maintained.

I have stopped using pydocstyle and substituted it with ruff. Moreover pydocstyle project has been deprecated and is no longer actively maintained.

Description

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

Uploaded Source

Built Distribution

flake8_pydocstyle-0.2.5-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flake8_pydocstyle-0.2.5.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Windows/11

File hashes

Hashes for flake8_pydocstyle-0.2.5.tar.gz
Algorithm Hash digest
SHA256 70dee3e8d2eebe1765aea2067cd33dfcfd83391c1a958230bd2fc417b67e6157
MD5 e9bd7959bf6c3d1aae643b856f07a263
BLAKE2b-256 312e77fe42b3b14ea1017caca0fbc62c4de06c5e0fe2d71a2c096b05c0ecf594

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flake8_pydocstyle-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8e3f78fe1510d5aa8492a7a3f6b2cdbacdb7d531c7d4a9dc6be7d37d3e0ddd08
MD5 400d99173e4b0cf24879cbb1636efb1d
BLAKE2b-256 e9302bbd7967b4737237cfbcbee5f3a27f5d93011d2edd1ff7965f0c6e60d4eb

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