{"id":30722764,"url":"https://github.com/emcd/python-dynadoc","last_synced_at":"2026-01-20T17:57:57.578Z","repository":{"id":295490504,"uuid":"990260370","full_name":"emcd/python-dynadoc","owner":"emcd","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-29T05:31:36.000Z","size":420,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-29T15:16:57.472Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emcd.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-25T20:24:42.000Z","updated_at":"2025-07-29T05:31:40.000Z","dependencies_parsed_at":"2025-05-25T21:29:39.618Z","dependency_job_id":"d2ca07a0-c81b-4ae3-9c93-e09bf110bfbc","html_url":"https://github.com/emcd/python-dynadoc","commit_stats":null,"previous_names":["emcd/python-dynadoc"],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/emcd/python-dynadoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emcd%2Fpython-dynadoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emcd%2Fpython-dynadoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emcd%2Fpython-dynadoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emcd%2Fpython-dynadoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emcd","download_url":"https://codeload.github.com/emcd/python-dynadoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emcd%2Fpython-dynadoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273437902,"owners_count":25105849,"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","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-09-03T11:37:43.076Z","updated_at":"2026-01-20T17:57:57.565Z","avatar_url":"https://github.com/emcd.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. vim: set fileencoding=utf-8:\n.. -*- coding: utf-8 -*-\n.. +--------------------------------------------------------------------------+\n   |                                                                          |\n   | Licensed under the Apache License, Version 2.0 (the \"License\");          |\n   | you may not use this file except in compliance with the License.         |\n   | You may obtain a copy of the License at                                  |\n   |                                                                          |\n   |     http://www.apache.org/licenses/LICENSE-2.0                           |\n   |                                                                          |\n   | Unless required by applicable law or agreed to in writing, software      |\n   | distributed under the License is distributed on an \"AS IS\" BASIS,        |\n   | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |\n   | See the License for the specific language governing permissions and      |\n   | limitations under the License.                                           |\n   |                                                                          |\n   +--------------------------------------------------------------------------+\n\n*******************************************************************************\n                                    dynadoc\n*******************************************************************************\n\n.. image:: https://img.shields.io/pypi/v/dynadoc\n   :alt: Package Version\n   :target: https://pypi.org/project/dynadoc/\n\n.. image:: https://img.shields.io/pypi/status/dynadoc\n   :alt: PyPI - Status\n   :target: https://pypi.org/project/dynadoc/\n\n.. image:: https://github.com/emcd/python-dynadoc/actions/workflows/tester.yaml/badge.svg?branch=master\u0026event=push\n   :alt: Tests Status\n   :target: https://github.com/emcd/python-dynadoc/actions/workflows/tester.yaml\n\n.. image:: https://emcd.github.io/python-dynadoc/coverage.svg\n   :alt: Code Coverage Percentage\n   :target: https://github.com/emcd/python-dynadoc/actions/workflows/tester.yaml\n\n.. image:: https://img.shields.io/github/license/emcd/python-dynadoc\n   :alt: Project License\n   :target: https://github.com/emcd/python-dynadoc/blob/master/LICENSE.txt\n\n.. image:: https://img.shields.io/pypi/pyversions/dynadoc\n   :alt: Python Versions\n   :target: https://pypi.org/project/dynadoc/\n\n\n📝 A Python library package which bridges the gap between **rich annotations**\nand **automatic documentation generation** with configurable renderers and\nsupport for reusable fragments.\n\n\nKey Features ⭐\n===============================================================================\n\n* 🔄 **Docstring Generation**: Generation of docstrings for modules, classes,\n  functions, and methods via introspection with fine-grained control.\n* 🧩 **Fragment System**: Reusable documentation snippets for consistent\n  terminology across projects.\n* 🏷️ **Annotation Metadata**: Extraction and inclusion of metadata from\n  annotations into generated docstrings.\n* 🔌 **Extensible Architecture**: Custom renderers, attribute visibility rules,\n  and introspection limiters.\n* 📖 **Sphinx-Compatible Output**: Render reStructuredText docstrings that work\n  with Sphinx Autodoc out of the box.\n* 🎨 **Configurable Renderers**: Ability to extend with other renderers as\n  desired.\n\n\nInstallation 📦\n===============================================================================\n\nMethod: Install Python Package\n-------------------------------------------------------------------------------\n\nInstall via `uv \u003chttps://github.com/astral-sh/uv/blob/main/README.md\u003e`_ ``pip``\ncommand:\n\n::\n\n    uv pip install dynadoc\n\nOr, install via ``pip``:\n\n::\n\n    pip install dynadoc\n\n\nExamples 💡\n===============================================================================\n\nPlease see the `examples directory\n\u003chttps://github.com/emcd/python-dynadoc/tree/master/documentation/examples\u003e`_.\n\n**Function Documentation**:\n\n.. code-block:: python\n\n    import dynadoc\n    from typing import Annotated\n\n    @dynadoc.with_docstring( )\n    def process_api_data(\n        endpoint: Annotated[ str, dynadoc.Doc( \"API endpoint URL to query\" ) ],\n        timeout: Annotated[ float, dynadoc.Doc( \"Request timeout in seconds\" ) ] = 30.0,\n    ) -\u003e Annotated[ dict, dynadoc.Doc( \"Processed API response data\" ) ]:\n        ''' Process data from API endpoint with configurable timeout. '''\n        return { }\n\nWhich will be turned into the following docstring on the function by the\ndefault renderer:\n\n.. code-block:: text\n\n    Process data from API endpoint with configurable timeout.\n\n    :argument endpoint: API endpoint URL to query\n    :type endpoint: str\n    :argument timeout: Request timeout in seconds\n    :type timeout: float\n    :returns: Processed API response data\n    :rtype: dict\n\n**Module Documentation**:\n\nDocument all annotated attributes in current module:\n\n.. code-block:: python\n\n    import dynadoc\n\n    dynadoc.assign_module_docstring( __name__ )\n\n\nContribution 🤝\n===============================================================================\n\nContribution to this project is welcome! However, it must follow the `code of\nconduct\n\u003chttps://emcd.github.io/python-project-common/stable/sphinx-html/common/conduct.html\u003e`_\nfor the project.\n\nPlease file bug reports and feature requests in the `issue tracker\n\u003chttps://github.com/emcd/python-dynadoc/issues\u003e`_ or submit `pull\nrequests \u003chttps://github.com/emcd/python-dynadoc/pulls\u003e`_ to\nimprove the source code or documentation.\n\nFor development guidance and standards, please see the `development guide\n\u003chttps://emcd.github.io/python-dynadoc/stable/sphinx-html/contribution.html#development\u003e`_.\n\n\nAdditional Indicia\n===============================================================================\n\n.. image:: https://img.shields.io/github/last-commit/emcd/python-dynadoc\n   :alt: GitHub last commit\n   :target: https://github.com/emcd/python-dynadoc\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json\n   :alt: Copier\n   :target: https://github.com/copier-org/copier\n\n.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg\n   :alt: Hatch\n   :target: https://github.com/pypa/hatch\n\n.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\n   :alt: pre-commit\n   :target: https://github.com/pre-commit/pre-commit\n\n.. image:: https://microsoft.github.io/pyright/img/pyright_badge.svg\n   :alt: Pyright\n   :target: https://microsoft.github.io/pyright\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n   :alt: Ruff\n   :target: https://github.com/astral-sh/ruff\n\n.. image:: https://img.shields.io/pypi/implementation/dynadoc\n   :alt: PyPI - Implementation\n   :target: https://pypi.org/project/dynadoc/\n\n.. image:: https://img.shields.io/pypi/wheel/dynadoc\n   :alt: PyPI - Wheel\n   :target: https://pypi.org/project/dynadoc/\n\n\nOther Projects by This Author 🌟\n===============================================================================\n\n\n* `python-absence \u003chttps://github.com/emcd/python-absence\u003e`_ (`absence \u003chttps://pypi.org/project/absence/\u003e`_ on PyPI)\n\n  🕳️ A Python library package which provides a **sentinel for absent values** - a falsey, immutable singleton that represents the absence of a value in contexts where ``None`` or ``False`` may be valid values.\n* `python-accretive \u003chttps://github.com/emcd/python-accretive\u003e`_ (`accretive \u003chttps://pypi.org/project/accretive/\u003e`_ on PyPI)\n\n  🌌 A Python library package which provides **accretive data structures** - collections which can grow but never shrink.\n* `python-classcore \u003chttps://github.com/emcd/python-classcore\u003e`_ (`classcore \u003chttps://pypi.org/project/classcore/\u003e`_ on PyPI)\n\n  🏭 A Python library package which provides **foundational class factories and decorators** for providing classes with attributes immutability and concealment and other custom behaviors.\n* `python-detextive \u003chttps://github.com/emcd/python-detextive\u003e`_ (`detextive \u003chttps://pypi.org/project/detextive/\u003e`_ on PyPI)\n\n  🕵️ A Python library which provides consolidated text detection capabilities for reliable content analysis. Offers MIME type detection, character set detection, and line separator processing.\n* `python-falsifier \u003chttps://github.com/emcd/python-falsifier\u003e`_ (`falsifier \u003chttps://pypi.org/project/falsifier/\u003e`_ on PyPI)\n\n  🎭 A very simple Python library package which provides a **base class for falsey objects** - objects that evaluate to ``False`` in boolean contexts.\n* `python-frigid \u003chttps://github.com/emcd/python-frigid\u003e`_ (`frigid \u003chttps://pypi.org/project/frigid/\u003e`_ on PyPI)\n\n  🔒 A Python library package which provides **immutable data structures** - collections which cannot be modified after creation.\n* `python-icecream-truck \u003chttps://github.com/emcd/python-icecream-truck\u003e`_ (`icecream-truck \u003chttps://pypi.org/project/icecream-truck/\u003e`_ on PyPI)\n\n  🍦 **Flavorful Debugging** - A Python library which enhances the powerful and well-known ``icecream`` package with flavored traces, configuration hierarchies, customized outputs, ready-made recipes, and more.\n* `python-librovore \u003chttps://github.com/emcd/python-librovore\u003e`_ (`librovore \u003chttps://pypi.org/project/librovore/\u003e`_ on PyPI)\n\n  🐲 **Documentation Search Engine** - An intelligent documentation search and extraction tool that provides both a command-line interface for humans and an MCP (Model Context Protocol) server for AI agents. Search across Sphinx and MkDocs sites with fuzzy matching, extract clean markdown content, and integrate seamlessly with AI development workflows.\n* `python-mimeogram \u003chttps://github.com/emcd/python-mimeogram\u003e`_ (`mimeogram \u003chttps://pypi.org/project/mimeogram/\u003e`_ on PyPI)\n\n  📨 A command-line tool for **exchanging collections of files with Large Language Models** - bundle multiple files into a single clipboard-ready document while preserving directory structure and metadata... good for code reviews, project sharing, and LLM interactions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femcd%2Fpython-dynadoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femcd%2Fpython-dynadoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femcd%2Fpython-dynadoc/lists"}