wf-disclosure-temp5 0.1.0

Generate Word-format Census Bureau disclosure documentation from a packet YAML and a support workbook.

wf-disclosure

Generate Word-format disclosure documentation for Census Bureau release packets. Turns a packet YAML + a long-format Excel support workbook + per-sample membership CSVs into a rendered .docx so that program names, sample sizes, estimate counts, tab descriptions, glossary entries, and implicit-sample residuals are all generated, never hand-typed.

Install

pip install wf-disclosure

For the Census internal environment without public-pip access, build a wheel locally and transfer it:

pip install build
python -m build
# then move dist/wf_disclosure-0.1.0-py3-none-any.whl into the environment and:
pip install wf_disclosure-0.1.0-py3-none-any.whl

Runtime prerequisites

wf-disclosure builds the YAML inputs. Rendering the .docx uses Quarto with the following R packages:

• A working quarto install (https://quarto.org)
• R with packages: yaml, purrr, glue, stringr

These are not Python dependencies and are installed separately.

Quick start

# 1. Scaffold a project directory with config/, templates/, inputs/, to_support/, derived/
wfd-init my_packet

# 2. Rename the example packet to disclosure_packet.yaml and edit it
cd my_packet
mv inputs/disclosure_packet.example.yaml inputs/disclosure_packet.yaml

# 3. Drop your support workbook + sample-membership CSVs
#    into to_support/ and to_support/sample_membership/

# 4. Detect implicit-sample subset relationships
wfd-detect

# 5. Build the disclosure inputs YAML
wfd-build

# 6. Render to docx with Quarto
quarto render templates/disclosure_documentation.qmd \
  -P input_file:derived/disclosure_inputs.yaml \
  -o disclosure_documentation.docx

wfd-detect and wfd-build accept --project-dir if you don't want to cd into the project.

What gets shipped

The wfd-init command copies these bundled defaults into your project directory:

• config/global_defaults.yaml — matching models, sample roles, release language
• config/description_templates.yaml — prose templates per (model, role)
• config/glossary.yaml — term/definition pairs
• templates/disclosure_documentation.qmd — Quarto template for the docx
• inputs/disclosure_packet.example.yaml — example packet showing the schema

These are plain files. Edit them in the project directory; they're versioned with your packet, not the installed package.

Python API

from pathlib import Path
from wf_disclosure import build, detect, WorkingDirs

dirs = WorkingDirs.from_root(Path("my_packet"))
detect.run(dirs)
build.run(dirs)

License

MIT