# 🧩 pylint-docstring-checker
A **Pylint plugin** that checks Python docstrings for **Google Python Style Guide** compliance
and detects **non-English (Vietnamese) docstrings**.
This plugin helps teams enforce consistent documentation and quality across Python projects.
---
## ✨ Features
✅ **Google Python Style Guide** validation:
- Checks for correct `Args:`, `Returns:`, and `Raises:` sections.
- Ensures the **summary line** exists, starts with a capital letter, and ends with a period.
- Requires a blank line between summary and detail sections (PEP-257 friendly).
🈲 **Language detection**:
- Warns if a docstring contains Vietnamese characters.
📊 **Summary report** at the end of each Pylint run:
```
📊 Docstring Summary Report:
- Total functions: 10
- With docstring: 8
- Without docstring: 2
- Vietnamese docstrings: 1
- English/Japanese docstrings: 7
- Google-style compliant: 4
- Google Style Coverage: 50.00%
- Coverage: 80.00%
```
---
## 🛠️ Installation
### From PyPI
```bash
pip install pylint-docstring-checker
```
---
## 🚀 Usage
### Run directly
```bash
pylint --load-plugins=pylint_docstring_checker your_module.py
```
### Or enable in `.pylintrc`
```ini
[MASTER]
load-plugins=pylint_docstring_checker
```
Then simply run:
```bash
pylint your_project/
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pylint-docstring-checker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "pylint, docstring, google style, linter",
"author": null,
"author_email": "AI&T <contact@ai-t.vn>",
"download_url": "https://files.pythonhosted.org/packages/ca/87/19a00119c153c93d2d53732577b9f4abf274bc92129b9aecd6fa3e9e9b07/pylint_docstring_checker-1.0.5.tar.gz",
"platform": null,
"description": "# \ud83e\udde9 pylint-docstring-checker\n\nA **Pylint plugin** that checks Python docstrings for **Google Python Style Guide** compliance \nand detects **non-English (Vietnamese) docstrings**.\n\nThis plugin helps teams enforce consistent documentation and quality across Python projects.\n\n---\n\n## \u2728 Features\n\n\u2705 **Google Python Style Guide** validation:\n- Checks for correct `Args:`, `Returns:`, and `Raises:` sections. \n- Ensures the **summary line** exists, starts with a capital letter, and ends with a period. \n- Requires a blank line between summary and detail sections (PEP-257 friendly). \n\n\ud83c\ude32 **Language detection**:\n- Warns if a docstring contains Vietnamese characters.\n\n\ud83d\udcca **Summary report** at the end of each Pylint run:\n```\n\ud83d\udcca Docstring Summary Report:\n- Total functions: 10\n- With docstring: 8\n- Without docstring: 2\n- Vietnamese docstrings: 1\n- English/Japanese docstrings: 7\n- Google-style compliant: 4\n- Google Style Coverage: 50.00%\n- Coverage: 80.00%\n```\n\n---\n\n## \ud83d\udee0\ufe0f Installation\n\n### From PyPI\n```bash\npip install pylint-docstring-checker\n```\n---\n\n## \ud83d\ude80 Usage\n\n### Run directly\n```bash\npylint --load-plugins=pylint_docstring_checker your_module.py\n```\n\n### Or enable in `.pylintrc`\n```ini\n[MASTER]\nload-plugins=pylint_docstring_checker\n```\n\nThen simply run:\n```bash\npylint your_project/\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Pylint plugin to check Google-style docstrings and language detection.",
"version": "1.0.5",
"project_urls": null,
"split_keywords": [
"pylint",
" docstring",
" google style",
" linter"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0e773db3720c019d1dabb3cc1d67b7ab6c2a87a74c231c032d4b53b708d3b831",
"md5": "26d41b4dbf64ccf0aeeab4f715e96a26",
"sha256": "02151f4576b0d37e234f22280805e3d447a68580434506937c23559f20ddb9d7"
},
"downloads": -1,
"filename": "pylint_docstring_checker-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26d41b4dbf64ccf0aeeab4f715e96a26",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7473,
"upload_time": "2025-10-30T04:47:02",
"upload_time_iso_8601": "2025-10-30T04:47:02.641626Z",
"url": "https://files.pythonhosted.org/packages/0e/77/3db3720c019d1dabb3cc1d67b7ab6c2a87a74c231c032d4b53b708d3b831/pylint_docstring_checker-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ca8719a00119c153c93d2d53732577b9f4abf274bc92129b9aecd6fa3e9e9b07",
"md5": "f4a480a0ae130bd6f821aac0abe94514",
"sha256": "4efcc198a3c8d396101e697e1a6bcc9b38d14901deb0af77b177e06d775c0b72"
},
"downloads": -1,
"filename": "pylint_docstring_checker-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "f4a480a0ae130bd6f821aac0abe94514",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5517,
"upload_time": "2025-10-30T04:47:03",
"upload_time_iso_8601": "2025-10-30T04:47:03.916586Z",
"url": "https://files.pythonhosted.org/packages/ca/87/19a00119c153c93d2d53732577b9f4abf274bc92129b9aecd6fa3e9e9b07/pylint_docstring_checker-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-30 04:47:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pylint-docstring-checker"
}
JSON