{"categories":[{"label":"Software Development","url":"https://skillfed.io/packages/category/software-development/14"},{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/8"},{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation/2"}],"enrichment":{"capability":"Extracts and serializes Python object documentation (modules, classes, functions, attributes) from source code, accepting JSON input describing what to document and outputting structured JSON with parsed docstrings and metadata.","skillfed_tags":["docstring-parsing","api-documentation","deprecated"],"use_cases":["Feed Python module paths to pytkdocs as JSON to extract docstrings and signatures for auto-generated API documentation.","Integrate pytkdocs into mkdocstrings or similar documentation generators to parse Python source without importing it.","Filter and select specific members of a module (e.g., public API only) and output structured metadata for custom doc tools.","Parse and normalize docstrings across multiple styles (Google, NumPy, reStructuredText) into a common JSON format.","Analyze Python code structure (classes, methods, attributes) and their documentation in a subprocess without loading the module directly."],"what_it_does":"pytkdocs is a command-line tool that introspects Python source code and outputs structured documentation as JSON. It reads a JSON request describing which Python objects to document (modules, classes, functions, etc.), then loads those objects, parses their docstrings in Google, NumPy, or reStructuredText format, and returns a JSON response with the extracted metadata, docstring sections, source locations, and object hierarchies. It supports filtering by name patterns, selecting inherited members, and configurable docstring parsing options.\n\nThe tool is designed to be used as a subprocess by other programs\u2014notably mkdocstrings\u2014feeding it single lines of JSON and reading back single lines of JSON in line-by-line mode. However, the project is now deprecated in favor of Griffe, a more powerful alternative. If you are starting a new documentation pipeline, Griffe is recommended; pytkdocs remains functional for existing integrations but is no longer actively developed.","worth_installing":"Yes, if you are maintaining an existing tool or workflow that already depends on pytkdocs. No, if you are starting a new documentation project\u2014the maintainers explicitly recommend Griffe as a more powerful alternative. The tool is stable and has no known vulnerabilities, but its aging maintenance status (last release 523 days ago) and deprecation notice mean it should not be the first choice for new integrations."},"id":"pytkdocs","links":{"html":"https://skillfed.io/packages/pytkdocs","md":"https://skillfed.io/packages/pytkdocs.md","pypi":"https://pypi.org/project/pytkdocs/"},"maintenance":{"status":"aging"},"meta":{"latest_release":"2025-03-09","license_spdx":"ISC","license_treatment":"permissive","name":"pytkdocs","python_support":"supports_current","summary":"Load Python objects documentation."},"popularity":{"monthly_downloads":170393,"position":10397,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.16.5"}