On this page

Agent first read๏ƒ

๐ŸŸข Beginner ยท Lesson 12

An agent's first sixty seconds with melder: read the workflow map from help(), read the version, then open the hardcopy system docs the package carries about itself. No filesystem, no web - the library IS its own documentation.

Before you run๏ƒ

Use the Beginner guide for prerequisite concepts. Run from a checkout with Melder installed and Python 3.14 free-threading selected. The collection download includes the level's local helper modules.

Run the saved script๏ƒ

python UX_and_AIX_experiences/01_beginner/12_agent_first_read.py
py -3.14t UX_and_AIX_experiences/01_beginner/12_agent_first_read.py

Download this collection ยท Source on GitHub

Public surface๏ƒ

md.doc, md.version, md.all, md.architecture, md.components, md.graph_network, md.graph_details

Code๏ƒ

 1"""
 2TIER: beginner (12) - the AIX seat
 3GOAL: An agent's first sixty seconds with melder: read the workflow map
 4      from help(), read the version, then open the hardcopy system docs
 5      the package carries about itself. No filesystem, no web - the
 6      library IS its own documentation.
 7SURFACE EXERCISED: md.__doc__, md.__version__, md.__all__,
 8                   md.__architecture__, md.__components__,
 9                   md.__graph_network__, md.__graph_details__
10"""
11import melder as md
12
13
14def main() -> None:
15    assert "Workflow map" in md.__doc__
16    print("workflow map present in help(melder)")
17    print("version:", md.__version__)
18
19    # the four hardcopy documents ride the wheel - an agent reads the
20    # system before touching it
21    for name in ("__architecture__", "__components__",
22                 "__graph_network__", "__graph_details__"):
23        doc = getattr(md, name)
24        assert doc is not None
25        print(name, "->", type(doc).__name__)
26
27    print("public surface advertised:", len(md.__all__), "names")
28
29
30if __name__ == "__main__":
31    main()

Check the outcome๏ƒ

The script contains its own assertions or demonstrated refusal paths. Run it to evaluate those checks against your installed version. The code above is taken directly from the saved file; no run output is invented here.

More beginner examples ยท Level guide