{"id":15133037,"url":"https://github.com/pycqa/pydocstyle","last_synced_at":"2025-12-12T00:46:31.765Z","repository":{"id":2353743,"uuid":"3316803","full_name":"PyCQA/pydocstyle","owner":"PyCQA","description":"docstring style checker","archived":true,"fork":false,"pushed_at":"2023-11-03T22:28:46.000Z","size":1012,"stargazers_count":1109,"open_issues_count":124,"forks_count":189,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-10-29T23:50:33.707Z","etag":null,"topics":["docstrings","linter","python"],"latest_commit_sha":null,"homepage":"http://pydocstyle.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PyCQA.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2012-01-31T17:18:23.000Z","updated_at":"2024-10-03T14:13:04.000Z","dependencies_parsed_at":"2023-02-10T12:16:51.310Z","dependency_job_id":"14668593-788b-4276-9669-62f1f64d3872","html_url":"https://github.com/PyCQA/pydocstyle","commit_stats":{"total_commits":584,"total_committers":98,"mean_commits":5.959183673469388,"dds":0.6164383561643836,"last_synced_commit":"8d0cdfc93e86e096bb5753f07dc5c7c373e63837"},"previous_names":["greensteam/pep257"],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyCQA%2Fpydocstyle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyCQA%2Fpydocstyle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyCQA%2Fpydocstyle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyCQA%2Fpydocstyle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PyCQA","download_url":"https://codeload.github.com/PyCQA/pydocstyle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234583683,"owners_count":18856280,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docstrings","linter","python"],"created_at":"2024-09-26T04:43:32.530Z","updated_at":"2025-09-29T02:32:34.569Z","avatar_url":"https://github.com/PyCQA.png","language":"Python","readme":"pydocstyle - docstring style checker\n====================================\n\n======================================\nDeprecation Notice: Pydocstyle\n======================================\n\n.. IMPORTANT: Deprecation Notice\n   :style: alert\n\n.. image:: https://img.shields.io/badge/deprecated-red\n   :target: https://github.com/PyCQA/pydocstyle\n   :alt: Deprecated\n\nThe Pydocstyle project is officially deprecated, and it is no longer actively maintained. \n\n\n\nRuff: A Modern Alternative\n--------------------------\n\n- **GitHub Repository:** `ruff \u003chttps://github.com/astral-sh/ruff\u003e`_\n\nRuff offers full parity with pydocstyle along with advanced features, better support for the latest Python versions, and ongoing development to ensure a top-notch linting experience. We highly recommend pydocstyle users to switch over to ruff for a seamless transition.\n\n\nA Heartfelt Thank You\n-----------------------\n\nWe want to express our heartfelt gratitude to the pydocstyle community, maintainers, and contributors for their support and dedication over the years. Your contributions have been invaluable, and we appreciate the time and effort you've invested in making pydocstyle a valuable tool for the Python community.\n\nThank you for your support of pydocstyle in the past.\n\n\n\n---------\n\n\n\n.. image:: https://github.com/PyCQA/pydocstyle/workflows/Run%20tests/badge.svg\n    :target: https://github.com/PyCQA/pydocstyle/actions?query=workflow%3A%22Run+tests%22+branch%3Amaster\n\n.. image:: https://readthedocs.org/projects/pydocstyle/badge/?version=latest\n    :target: https://readthedocs.org/projects/pydocstyle/?badge=latest\n    :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/pyversions/pydocstyle.svg\n    :target: https://pypi.org/project/pydocstyle\n\n.. image:: https://pepy.tech/badge/pydocstyle\n    :target: https://pepy.tech/project/pydocstyle\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n\n.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat\u0026labelColor=ef8336\n    :target: https://pycqa.github.io/isort/\n\n.. image:: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod\n    :target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle\n    :alt: Gitpod ready-to-code\n\n**pydocstyle** is a static analysis tool for checking compliance with Python\ndocstring conventions.\n\n**pydocstyle** supports most of\n`PEP 257 \u003chttp://www.python.org/dev/peps/pep-0257/\u003e`_ out of the box, but it\nshould not be considered a reference implementation.\n\n**pydocstyle** supports Python 3.6+.\n\n\nQuick Start\n-----------\n\nInstall\n^^^^^^^\n\n.. code::\n\n    pip install pydocstyle\n\n\nRun\n^^^\n\n.. code::\n\n    $ pydocstyle test.py\n    test.py:18 in private nested class `meta`:\n            D101: Docstring missing\n    test.py:27 in public function `get_user`:\n        D300: Use \"\"\"triple double quotes\"\"\" (found '''-quotes)\n    test:75 in public function `init_database`:\n        D201: No blank lines allowed before function docstring (found 1)\n    ...\n\nDevelop\n^^^^^^^\n\nYou can use Gitpod to run pre-configured dev environment in the cloud right from your browser -\n\n.. image:: https://gitpod.io/button/open-in-gitpod.svg\n    :target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle\n    :alt: Open in Gitpod\n    \nBefore submitting a PR make sure that you run `make all`.\n\nLinks\n-----\n\n* `Read the full documentation here \u003chttps://pydocstyle.org/en/stable/\u003e`_.\n\n* `Fork pydocstyle on GitHub \u003chttps://github.com/PyCQA/pydocstyle\u003e`_.\n\n* `PyPI project page \u003chttps://pypi.python.org/pypi/pydocstyle\u003e`_.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpycqa%2Fpydocstyle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpycqa%2Fpydocstyle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpycqa%2Fpydocstyle/lists"}