rstcheck-core
Checks syntax of reStructuredText and code blocks nested within it
Decision gist · record as of 2026-08-14
Yes. rstcheck-core is actively maintained, has low install friction, carries no known vulnerabilities, and uses a permissive license. It solves a clear problem—validating RST and embedded code blocks—with minimal dependencies. Install it if you need RST validation in documentation workflows or CI pipelines.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later.
- Low friction install with only two runtime dependencies (docutils and pydantic).
- Active maintenance with a release 17 days ago; repository is not archived and receives regular commits.
License · maintenance · safety
MIT (permissive) — MIT license is permissive, allowing use in commercial and private projects with minimal restrictions—only requiring license and copyright notice retention.
last release 2026-07-28 (17 days) · last repo commit 2026-08-10 · 4 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 995,626 downloads/mo, #4,549 on PyPI
Alternatives
Verify before relying
pip install rstcheck_core
from rstcheck_core.checker import RstChecker
checker = RstChecker()
results = checker.check_file('document.rst')- Whether the package can be used as a library API or is primarily a CLI tool—the fact sheet does not clarify the primary usage pattern.
- Performance characteristics when checking large documents or many files—no benchmarking data provided.
- Whether optional extras (toml, sphinx, yaml) are needed for typical usage or only for specific workflows.
What it is and what it does
rstcheck-core is a library for validating reStructuredText documents and the code blocks they contain. It checks RST syntax correctness and can validate nested code in multiple languages—Bash, Python, C/C++, JSON, XML, YAML, Doctest, and reStructuredText itself. The package depends on docutils for RST parsing and pydantic for configuration, making it suitable for integration into documentation pipelines, CI/CD workflows, or as a linting component in larger tools.
The library is actively maintained and supports current Python versions (3.10+). It offers optional extras for additional functionality: TOML configuration support, Sphinx integration, and YAML validation. With no known security vulnerabilities and a permissive MIT license, it presents a low-friction option for projects that need to enforce RST quality as part of their build or validation process.
Use it for
- Validate RST documentation in CI/CD pipelines to catch syntax errors before publishing.
- Check code examples embedded in docstrings or documentation for correctness.
- Lint Sphinx documentation projects to ensure consistent RST formatting.
- Integrate into pre-commit hooks to validate RST changes before commit.
- Validate YAML or JSON blocks within RST documents when using optional extras.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
rstcheck-core is actively maintained, has low install friction, carries no known vulnerabilities, and uses a permissive license. It solves a clear problem—validating RST and embedded code blocks—with minimal dependencies. Install it if you need RST validation in documentation workflows or CI pipelines.
Install
rstcheck-core on PyPI
Before you install
Low friction install with only two runtime dependencies (docutils and pydantic). Active maintenance with a release 17 days ago; repository is not archived and receives regular commits.
Requires Python 3.10 or later.
License in practice
MIT license is permissive, allowing use in commercial and private projects with minimal restrictions—only requiring license and copyright notice retention.
Quickstart
pip install rstcheck_core
from rstcheck_core.checker import RstChecker
checker = RstChecker()
results = checker.check_file('document.rst')Verify before relying
- Whether the package can be used as a library API or is primarily a CLI tool—the fact sheet does not clarify the primary usage pattern.
- Performance characteristics when checking large documents or many files—no benchmarking data provided.
- Whether optional extras (toml, sphinx, yaml) are needed for typical usage or only for specific workflows.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesdocutilspydantic |
| Maintenance | Actively maintained 17 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 995,626 / month, #4,549 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Topic :: Software Development :: Quality Assurance |
Evidence: rstcheck_core-1.3.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “code block validation”
- rstcheck-coreValidates reStructuredText syntax and checks code blocks embedded…
- sybil-extrasProvides specialized evaluators and parsers that extend Sybil, a…
- rstcheckValidates reStructuredText syntax and checks code blocks nested…
Give your agent the search over MCP, or paste the wish link into any chat.
More Quality Assurance packages
Coverage.py measures which lines of Python code are executed during test runs, reporting coverage percentages and identifying untested code paths.
Install it if you want to measure test completeness or enforce coverage thresholds in your project.
Ruff is a Python linter and code formatter written in Rust that combines linting, formatting, and code fixing into a single tool, replacing Flake8, Black, isort, and related utilities.
Pexpect spawns and controls interactive console applications by sending input and matching output patterns, automating tasks that would otherwise require manual interaction.
Black reformats Python source code to a consistent style by parsing entire files and rewriting them according to an opinionated, deterministic set of rules, eliminating manual formatting decisions.
pytest-xdist distributes pytest tests across multiple CPU cores or machines to speed up test execution, with the simplest usage being `pytest -n auto` to spawn workers equal to available CPUs.
Install it if your test suite takes long enough that parallelization would save meaningful time.
Validates AWS CloudFormation templates in YAML or JSON format against resource provider schemas and best practices, checking property values and configuration correctness.
Install it if you work with CloudFormation templates.
See also rstcheck · sphinx-lint · restructuredtext-lint · flake8-rst-docstrings · doc8 · docstrfmt · rich-rst · m2r2 · doccmd · sybil