annotated-doc

Document parameters, class attributes, return types, and variables inline, with Annotated.

annotated-doc Permissive license MIT Active ★ 80 v0.0.5 released 2026-07-28

Install

annotated-doc on PyPI

pip

pip install annotated-doc

uv

uv add annotated-doc

poetry

poetry add annotated-doc

Package facts

License	MIT (permissive)
Python support	supports the current Python release (>=3.9)
Install friction	low — pure-Python wheel
Runtime dependencies	none
Maintenance	actively maintained — 16 days since the last release
Last repo commit	2026-08-12
First released	2023-12-11
Popularity	one of the 100 most-downloaded packages on PyPI (30-day window, as of 2026-08-13)
Known vulnerabilities	none known (OSV.dev, checked 2026-08-13)

Evidence: annotated_doc-0.0.5-py3-none-any.whl

Development Status :: 4 - BetaIntended Audience :: DevelopersIntended Audience :: Information TechnologyIntended Audience :: System AdministratorsOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: 3.9Topic :: InternetTopic :: Software DevelopmentTopic :: Software Development :: LibrariesTopic :: Software Development :: Libraries :: Application FrameworksTopic :: Software Development :: Libraries :: Python ModulesTyping :: Typed

About annotated-doc

from the package's own PyPI description — quoted content, verbatim

Annotated Doc

Document parameters, class attributes, return types, and variables inline, with Annotated.

Installation

pip install annotated-doc

Or with uv:

uv add annotated-doc

Usage

Import Doc and pass a single literal string with the documentation for the specific parameter, class...

Read as markdown · JSON record · Source repository · Homepage · Docs

AI interpretation — verify before relying

AI-generated interpretation of the package facts above; every digit, version, license, or vulnerability id it cites is grounded in the facts already shown on this page

Provides a lightweight way to document function parameters, class attributes, return types, and variables using Python's `Annotated` type hint syntax instead of traditional docstrings.

Minimal friction: pure Python wheel with no runtime dependencies, released 16 days ago with active maintenance and recent commits. Supports Python 3.9 through 3.14.

MIT license permits unrestricted commercial and private use, modification, and distribution with only attribution required.

Usage

pip install annotated-doc

from typing import Annotated
from annotated_doc import Doc

def greet(name: Annotated[str, Doc("Person to greet")]) -> None:
    print(f"Hello, {name}!")

Verdict: A lightweight, actively maintained library with no dependencies that brings inline documentation to Python type hints. Ideal for FastAPI, Typer, and similar frameworks where parameter documentation lives close to its definition. MIT-licensed and widely compatible across current Python versions.

Needs verification

Whether the package is actually used by FastAPI, Typer, SQLModel, and Asyncer as claimed, or only supported by griffe-typingdoc
Runtime performance impact of using Annotated with Doc metadata at scale

annotated type documentationinline parameter documentationtype hint doc stringspython annotated metadatafastapi doc annotationsclass attribute documentationruntime type annotations