https://github.com/emcd/python-dynadoc
https://github.com/emcd/python-dynadoc
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/emcd/python-dynadoc
- Owner: emcd
- License: apache-2.0
- Created: 2025-05-25T20:24:42.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-07-29T05:31:36.000Z (11 months ago)
- Last Synced: 2025-08-29T15:16:57.472Z (10 months ago)
- Language: Python
- Size: 410 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
.. vim: set fileencoding=utf-8:
.. -*- coding: utf-8 -*-
.. +--------------------------------------------------------------------------+
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| |
+--------------------------------------------------------------------------+
*******************************************************************************
dynadoc
*******************************************************************************
.. image:: https://img.shields.io/pypi/v/dynadoc
:alt: Package Version
:target: https://pypi.org/project/dynadoc/
.. image:: https://img.shields.io/pypi/status/dynadoc
:alt: PyPI - Status
:target: https://pypi.org/project/dynadoc/
.. image:: https://github.com/emcd/python-dynadoc/actions/workflows/tester.yaml/badge.svg?branch=master&event=push
:alt: Tests Status
:target: https://github.com/emcd/python-dynadoc/actions/workflows/tester.yaml
.. image:: https://emcd.github.io/python-dynadoc/coverage.svg
:alt: Code Coverage Percentage
:target: https://github.com/emcd/python-dynadoc/actions/workflows/tester.yaml
.. image:: https://img.shields.io/github/license/emcd/python-dynadoc
:alt: Project License
:target: https://github.com/emcd/python-dynadoc/blob/master/LICENSE.txt
.. image:: https://img.shields.io/pypi/pyversions/dynadoc
:alt: Python Versions
:target: https://pypi.org/project/dynadoc/
📝 A Python library package which bridges the gap between **rich annotations**
and **automatic documentation generation** with configurable renderers and
support for reusable fragments.
Key Features ⭐
===============================================================================
* 🔄 **Docstring Generation**: Generation of docstrings for modules, classes,
functions, and methods via introspection with fine-grained control.
* 🧩 **Fragment System**: Reusable documentation snippets for consistent
terminology across projects.
* 🏷️ **Annotation Metadata**: Extraction and inclusion of metadata from
annotations into generated docstrings.
* 🔌 **Extensible Architecture**: Custom renderers, attribute visibility rules,
and introspection limiters.
* 📖 **Sphinx-Compatible Output**: Render reStructuredText docstrings that work
with Sphinx Autodoc out of the box.
* 🎨 **Configurable Renderers**: Ability to extend with other renderers as
desired.
Installation 📦
===============================================================================
Method: Install Python Package
-------------------------------------------------------------------------------
Install via `uv `_ ``pip``
command:
::
uv pip install dynadoc
Or, install via ``pip``:
::
pip install dynadoc
Examples 💡
===============================================================================
Please see the `examples directory
`_.
**Function Documentation**:
.. code-block:: python
import dynadoc
from typing import Annotated
@dynadoc.with_docstring( )
def process_api_data(
endpoint: Annotated[ str, dynadoc.Doc( "API endpoint URL to query" ) ],
timeout: Annotated[ float, dynadoc.Doc( "Request timeout in seconds" ) ] = 30.0,
) -> Annotated[ dict, dynadoc.Doc( "Processed API response data" ) ]:
''' Process data from API endpoint with configurable timeout. '''
return { }
Which will be turned into the following docstring on the function by the
default renderer:
.. code-block:: text
Process data from API endpoint with configurable timeout.
:argument endpoint: API endpoint URL to query
:type endpoint: str
:argument timeout: Request timeout in seconds
:type timeout: float
:returns: Processed API response data
:rtype: dict
**Module Documentation**:
Document all annotated attributes in current module:
.. code-block:: python
import dynadoc
dynadoc.assign_module_docstring( __name__ )
Contribution 🤝
===============================================================================
Contribution to this project is welcome! However, it must follow the `code of
conduct
`_
for the project.
Please file bug reports and feature requests in the `issue tracker
`_ or submit `pull
requests `_ to
improve the source code or documentation.
For development guidance and standards, please see the `development guide
`_.
Additional Indicia
===============================================================================
.. image:: https://img.shields.io/github/last-commit/emcd/python-dynadoc
:alt: GitHub last commit
:target: https://github.com/emcd/python-dynadoc
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json
:alt: Copier
:target: https://github.com/copier-org/copier
.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg
:alt: Hatch
:target: https://github.com/pypa/hatch
.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
:alt: pre-commit
:target: https://github.com/pre-commit/pre-commit
.. image:: https://microsoft.github.io/pyright/img/pyright_badge.svg
:alt: Pyright
:target: https://microsoft.github.io/pyright
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:alt: Ruff
:target: https://github.com/astral-sh/ruff
.. image:: https://img.shields.io/pypi/implementation/dynadoc
:alt: PyPI - Implementation
:target: https://pypi.org/project/dynadoc/
.. image:: https://img.shields.io/pypi/wheel/dynadoc
:alt: PyPI - Wheel
:target: https://pypi.org/project/dynadoc/
Other Projects by This Author 🌟
===============================================================================
* `python-absence `_ (`absence `_ on PyPI)
🕳️ 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.
* `python-accretive `_ (`accretive `_ on PyPI)
🌌 A Python library package which provides **accretive data structures** - collections which can grow but never shrink.
* `python-classcore `_ (`classcore `_ on PyPI)
🏭 A Python library package which provides **foundational class factories and decorators** for providing classes with attributes immutability and concealment and other custom behaviors.
* `python-detextive `_ (`detextive `_ on PyPI)
🕵️ A Python library which provides consolidated text detection capabilities for reliable content analysis. Offers MIME type detection, character set detection, and line separator processing.
* `python-falsifier `_ (`falsifier `_ on PyPI)
🎭 A very simple Python library package which provides a **base class for falsey objects** - objects that evaluate to ``False`` in boolean contexts.
* `python-frigid `_ (`frigid `_ on PyPI)
🔒 A Python library package which provides **immutable data structures** - collections which cannot be modified after creation.
* `python-icecream-truck `_ (`icecream-truck `_ on PyPI)
🍦 **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.
* `python-librovore `_ (`librovore `_ on PyPI)
🐲 **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.
* `python-mimeogram `_ (`mimeogram `_ on PyPI)
📨 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.