textproc/py-docify 1.2.1

Script to add docstrings to Python type stubs using reflection

Repository: FreeBSD ports
Maintainer: [email protected]
Port added: 2026-08-19
Last update: 2026-08-19
Commit: 5ab100563a
License: MIT
Categories: textproc, python
Package size: 23.9 KiB, 99.9 KiB installed

Description

docify is a script to add docstrings to Python type stubs using reflection.

Features:

Uses LibCST to parse and modify the stub file
Dynamically imports the actual module to get the runtime docstring
Handles most sys.version and sys.platform conditional blocks, will only add docstrings to the correct branch
Able to modify files in-place with -i or --in-place
Won't overwrite existing docstrings
With -b or --builtins-only, will only add docstrings for modules found in sys.builtin_module_names (stdlib modules written in C).
With --if-needed, will only add docstrings if the object's (Python) source code is unavailable. Useful for language servers like basedpyright that are able to extract docstrings from source code.

Install

As a binary package — by origin, or by package name:

pkg install textproc/py-docify
pkg install py312-docify

From the ports tree:

cd /usr/ports/textproc/py-docify/ && make install clean

To depend on this port in another port's Makefile:

RUN_DEPENDS=	py312-docify>0:textproc/py-docify

Packages

The version each package repository carries. “-” means the repository builds no package of it, “n/a” that there is no such repository.

Repository	aarch64	amd64	armv6	armv7	i386
FreeBSD:14:latest	1.2.1	1.2.1	-	-	1.2.1
FreeBSD:14:quarterly	1.2.1	1.2.1	n/a	-	1.2.1
FreeBSD:15:latest	1.2.1	1.2.1	n/a	-	-
FreeBSD:15:quarterly	1.2.1	1.2.1	n/a	n/a	n/a
FreeBSD:16:latest	1.2.1	1.2.1	n/a	n/a	n/a
FreeBSD:16:quarterly	n/a	n/a	n/a	n/a	n/a

Dependencies

As this port's Makefile names them.

Build 1

${PYTHON_PKGNAMEPREFIX}hatchling>=0 : devel/py-hatchling

Runtime 2

${PYTHON_PKGNAMEPREFIX}libcst>=1.1.0 : devel/py-libcst
${PYTHON_PKGNAMEPREFIX}tqdm>=4.66.4 : misc/py-tqdm

The full lists below include those, and their dependencies in turn.

All build dependencies 19

All run dependencies 11

No port depends on this one.

Configuration

No options to configure.

USES: python shebangfix
Service scripts: none

Files

distinfo 1

File	Size	SHA256
docify-1.2.1.tar.gz	30605	ed565259a3b20cd754438405b7830e12579f2223bb3c3f13c8e9318c258bc0a8

File

Size

SHA256

docify-1.2.1.tar.gz

30605

ed565259a3b20cd754438405b7830e12579f2223bb3c3f13c8e9318c258bc0a8

Master sites 1

PYPI

Commit history 1

Date Commit Credits Log message

Date	Commit	Credits	Log message
2026-08-19	`5ab100563a`	Po-Chuan Hsieh	textproc/py-docify: Add py-docify 1.2.1 docify is a script to add docstrings to Python type stubs using reflection. Features: - Uses LibCST to parse and modify the stub file - Dynamically imports the actual module to get the runtime docstring - Handles most sys.version and sys.platform conditional blocks, will only add docstrings to the correct branch - Able to modify files in-place with -i or --in-place - Won't overwrite existing docstrings - With -b or --builtins-only, will only add docstrings for modules found in sys.builtin_module_names (stdlib modules written in C). - With --if-needed, will only add docstrings if the object's (Python) source code is unavailable. Useful for language servers like basedpyright that are able to extract docstrings from source code.

2026-08-19

5ab100563a

Po-Chuan Hsieh

textproc/py-docify: Add py-docify 1.2.1

docify is a script to add docstrings to Python type stubs using reflection. Features: - Uses LibCST to parse and modify the stub file - Dynamically imports the actual module to get the runtime docstring - Handles most sys.version and sys.platform conditional blocks, will only add docstrings to the correct branch - Able to modify files in-place with -i or --in-place - Won't overwrite existing docstrings - With -b or --builtins-only, will only add docstrings for modules found in sys.builtin_module_names (stdlib modules written in C). - With --if-needed, will only add docstrings if the object's (Python) source code is unavailable. Useful for language servers like basedpyright that are able to extract docstrings from source code.