flake8-docstrings


Nameflake8-docstrings JSON
Version 1.0.3 PyPI version JSON
home_pagehttps://gitlab.com/pycqa/flake8-docstrings
SummaryExtension for flake8 which uses pydocstyle to check docstrings
upload_time2017-01-24 12:09:43
maintainer
docs_urlNone
authorIan Cordasco
requires_python
licenseMIT License
keywords pep 257 pydocstyle pep257 docstrings flake8
VCS
bugtrack_url https://bitbucket.org/icordasc/flake8-docstrings/issues?status=new&status=open
requirements No requirements were recorded.
Travis-CI No Travis.
Coveralis test coverage No Coveralis.
            flake8-docstrings
=================

A simple module that adds an extension for the fantastic pydocstyle_ tool to
flake8_.

Simply install this extension::

    pip install flake8_docstrings

and run flake8.

Report any issues on our `bug tracker`_.

.. _pydocstyle: https://github.com/pycqa/pydocstyle
.. _flake8: https://gitlab.com/pycqa/flake8
.. _bug tracker: https://gitlab.com/pycqa/flake8-docstrings/issues


History/Changelog
=================

1.0.3
-----

- Use flake8-polyfill to get standard-in to handle Flake8 3.x and 2.x

1.0.2
-----

- Use pycodestyle to get standard-in.

1.0.1
-----

- Make sure this works out of the box (is enabled by default) with Flake8 3.0

1.0.0
-----

- Switch dependency name to pydocstyle. pep257 was renamed to pydocstyle, this
  update switches the requirement to that new package name. Since we're
  swapping out dependencies, we've issued a major version bump.

0.2.7
-----

- Try to import pydocstyle (not pycodestyle) as pep257

0.2.6
-----

- Respect pep257's default ignore list

- Handle AllError and other exceptions from pep257

0.2.5
-----

- Use pep257's ``tokenize_open`` function to pass input to the tool.

- Use pep257's conventions so any error codes that are ignored by default
  using ``pep257`` are also ignored by default with this plugin.

0.2.4
-----

- Fix bug introduced in 0.2.2 where the file source was always None causing
  D100 and D104 errors for all files and no other errors to be found.

0.2.3
-----

- Remove extraneous space in error message.

- Fix up how the plugin displays with ``flake8 --version``.

0.2.2
-----

- Better support for input provided via stdin.

0.2.1
-----

- Prevent AllError or EnvironmentErrors from being raised. Thanks Alex
  Pyrgiotis.

0.2.0
-----

- Upgrade to pep257 0.3.0

0.1.4
-----

- Stop truncating error messages

0.1.3
-----

- Really fix the installation issue this time.

0.1.2
-----

- Actually fix the PyPI release. **Ugh**

0.1.1
-----

- Fix the PyPI release.

0.1.0
-----

- Initial Release!



            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "PEP 257,pydocstyle,pep257,docstrings,flake8", 
    "upload_time": "2017-01-24 12:09:43", 
    "author": "Ian Cordasco", 
    "home_page": "https://gitlab.com/pycqa/flake8-docstrings", 
    "download_url": "https://pypi.python.org/packages/2d/72/2900b5746daeaa128ab00107b2683e193da60a374045b924e548acd9bd10/flake8-docstrings-1.0.3.tar.gz", 
    "platform": "", 
    "version": "1.0.3", 
    "cheesecake_documentation_id": null, 
    "description": "flake8-docstrings\n=================\n\nA simple module that adds an extension for the fantastic pydocstyle_ tool to\nflake8_.\n\nSimply install this extension::\n\n    pip install flake8_docstrings\n\nand run flake8.\n\nReport any issues on our `bug tracker`_.\n\n.. _pydocstyle: https://github.com/pycqa/pydocstyle\n.. _flake8: https://gitlab.com/pycqa/flake8\n.. _bug tracker: https://gitlab.com/pycqa/flake8-docstrings/issues\n\n\nHistory/Changelog\n=================\n\n1.0.3\n-----\n\n- Use flake8-polyfill to get standard-in to handle Flake8 3.x and 2.x\n\n1.0.2\n-----\n\n- Use pycodestyle to get standard-in.\n\n1.0.1\n-----\n\n- Make sure this works out of the box (is enabled by default) with Flake8 3.0\n\n1.0.0\n-----\n\n- Switch dependency name to pydocstyle. pep257 was renamed to pydocstyle, this\n  update switches the requirement to that new package name. Since we're\n  swapping out dependencies, we've issued a major version bump.\n\n0.2.7\n-----\n\n- Try to import pydocstyle (not pycodestyle) as pep257\n\n0.2.6\n-----\n\n- Respect pep257's default ignore list\n\n- Handle AllError and other exceptions from pep257\n\n0.2.5\n-----\n\n- Use pep257's ``tokenize_open`` function to pass input to the tool.\n\n- Use pep257's conventions so any error codes that are ignored by default\n  using ``pep257`` are also ignored by default with this plugin.\n\n0.2.4\n-----\n\n- Fix bug introduced in 0.2.2 where the file source was always None causing\n  D100 and D104 errors for all files and no other errors to be found.\n\n0.2.3\n-----\n\n- Remove extraneous space in error message.\n\n- Fix up how the plugin displays with ``flake8 --version``.\n\n0.2.2\n-----\n\n- Better support for input provided via stdin.\n\n0.2.1\n-----\n\n- Prevent AllError or EnvironmentErrors from being raised. Thanks Alex\n  Pyrgiotis.\n\n0.2.0\n-----\n\n- Upgrade to pep257 0.3.0\n\n0.1.4\n-----\n\n- Stop truncating error messages\n\n0.1.3\n-----\n\n- Really fix the installation issue this time.\n\n0.1.2\n-----\n\n- Actually fix the PyPI release. **Ugh**\n\n0.1.1\n-----\n\n- Fix the PyPI release.\n\n0.1.0\n-----\n\n- Initial Release!\n\n\n", 
    "lcname": "flake8-docstrings", 
    "bugtrack_url": "https://bitbucket.org/icordasc/flake8-docstrings/issues?status=new&status=open", 
    "github": false, 
    "name": "flake8-docstrings", 
    "license": "MIT License", 
    "summary": "Extension for flake8 which uses pydocstyle to check docstrings", 
    "split_keywords": [
        "pep 257", 
        "pydocstyle", 
        "pep257", 
        "docstrings", 
        "flake8"
    ], 
    "author_email": "graffatcolmingov@gmail.com", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2017-01-24T12:09:43", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/2d/72/2900b5746daeaa128ab00107b2683e193da60a374045b924e548acd9bd10/flake8-docstrings-1.0.3.tar.gz", 
            "md5_digest": "623237d51646117bf31e403c779461c9", 
            "downloads": 0, 
            "filename": "flake8-docstrings-1.0.3.tar.gz", 
            "packagetype": "sdist", 
            "path": "2d/72/2900b5746daeaa128ab00107b2683e193da60a374045b924e548acd9bd10/flake8-docstrings-1.0.3.tar.gz", 
            "size": 4532
        }, 
        {
            "has_sig": false, 
            "upload_time": "2017-01-24T12:09:42", 
            "comment_text": "", 
            "python_version": "py2.py3", 
            "url": "https://pypi.python.org/packages/23/d7/553eb22219ec6a348b6ad73eb91bb17fb727a17dd24f0ff751ca0b9ea47e/flake8_docstrings-1.0.3-py2.py3-none-any.whl", 
            "md5_digest": "a0427eeba9d829bf30c7281887fd7d06", 
            "downloads": 0, 
            "filename": "flake8_docstrings-1.0.3-py2.py3-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "23/d7/553eb22219ec6a348b6ad73eb91bb17fb727a17dd24f0ff751ca0b9ea47e/flake8_docstrings-1.0.3-py2.py3-none-any.whl", 
            "size": 5540
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}