{"id":23444,"library":"collective-checkdocs","title":"collective.checkdocs","description":"A distutils command to view and validate reStructuredText in a package's long_description. Current version 0.2, last released in 2012 (in maintenance mode).","status":"maintenance","version":"0.2","language":"python","source_language":"en","source_url":"https://github.com/collective/collective.checkdocs","tags":["distutils","reStructuredText","validation","long_description","setup.py"],"install":[{"cmd":"pip install collective.checkdocs","lang":"bash","label":"PyPI"}],"dependencies":[{"reason":"required for setup.py command","package":"setuptools","optional":false},{"reason":"required for reST parsing","package":"docutils","optional":false},{"reason":"syntax highlighting in rendered output","package":"Pygments","optional":true}],"imports":[{"wrong":"from setuptools import setup","symbol":"checkdocs","correct":"from collective.checkdocs import checkdocs"}],"quickstart":{"code":"# In setup.py:\nfrom setuptools import setup\nsetup(\n    name='mypackage',\n    version='0.1',\n    description='My package',\n    long_description=open('README.rst').read(),\n    setup_requires=['collective.checkdocs'],\n    # ...\n)\n# Then run: python setup.py checkdocs","lang":"python","description":"Add 'collective.checkdocs' to setup_requires and use the 'checkdocs' command to validate long_description."},"warnings":[{"fix":"Use 'twine check dist/*' after building your package.","message":"collective.checkdocs is unmaintained since 2012; consider using 'twine check' instead.","severity":"deprecated","affected_versions":"all"},{"fix":"Only add to setup_requires in setup.py, never to install_requires.","message":"The package is installed as a setup_requires dependency, not a regular runtime dependency. Adding it to install_requires will break deployments.","severity":"gotcha","affected_versions":"all"},{"fix":"Use 'twine check' or 'rstcheck' for modern Python versions.","message":"Python 3 compatibility was never officially released; may fail on Python 3.6+.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"search_vec":"'0.2':18 '2012':22 'collective.checkdocs':1 'command':4 'current':16 'descript':15,30 'distutil':3,26 'last':19 'long':14,29 'mainten':24 'mode':25 'packag':12 'releas':20 'restructuredtext':9,27 'setup.py':31 'valid':8,28 'version':17 'view':6","created_at":"2026-05-01T08:07:48.550131+00:00","updated_at":"2026-05-01T08:07:48.550131+00:00","problems":{"verify_error":"Traceback (most recent call last):\n  File \"<string>\", line 1, in <module>\n  File \"/tmp/tmpycxlootp/venv/lib/python3.12/site-packages/collective/checkdocs/__init__.py\", line 22, in <module>\n    from distutils.errors import CompileError\nModuleNotFoundError: No module named 'distutils'"},"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":"0.2","cli_name":"checkdocs","cli_version":"sh: 1: checkdocs: not found","type":"library","homepage":null,"github":"https://github.com/collective/collective.checkdocs","docs":null,"changelog":null,"pypi":"https://pypi.org/project/collective-checkdocs/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["testing","devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"import_fail","verified_at":"2026-07-03","last_verified":"2026-07-03","next_check":"2026-07-10","install_tag":null}}