docs(py): add docstring to parse.py and dotprompt.py modules. (#246)

Author: yesudeep

python/dotpromptz/src/dotpromptz/dotprompt.py

@@ -14,7 +14,28 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-"""Dotpromptz is a library for generating prompts using Handlebars templates."""
+"""Dotpromptz is a library for generating prompts using Handlebars templates.
+
+This module provides the core Dotprompt class, which extends the Handlebars
+template engine for use with generative AI prompts. It supports parsing
+templates, rendering metadata, resolving tools and partials, and managing
+schemas.
+
+Key features include:
+
+| Feature              | Description                                                                             |
+|----------------------|-----------------------------------------------------------------------------------------|
+| Template Parsing     | Parsing of templates with YAML frontmatter for metadata.                                |
+| Metadata Rendering   | Rendering of prompt metadata, including merging and resolving tools and schemas.        |
+| Tool Resolution      | Resolving tool names to tool definitions using a resolver or a static mapping.          |
+| Partial Resolution   | Resolving partial template names to their content using a resolver or a static mapping. |
+| Schema Management    | Handling of JSON schemas, including Picoschema conversion.                              |
+| Helper Functions     | Registration and management of custom helper functions.                                 |
+| Partial Templates    | Registration and management of partial templates.                                       |
+| Model Configuration  | Support for default models and model-specific configurations.                           |
+| Prompt Store         | Integration with a prompt store for loading prompts and partials.                       |
+| Extensibility        | Designed to be extensible with custom helpers, resolvers, and stores.                   |
+"""
 
 from __future__ import annotations
 

python/dotpromptz/src/dotpromptz/parse.py

@@ -14,7 +14,24 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-"""Parse dotprompt templates and extract metadata."""
+"""Parses dotprompt templates and extracts metadata.
+
+This module is responsible for parsing dotprompt templates. It handles extracting
+metadata from YAML frontmatter and converting the template content into a
+structured format, specifically a list of messages and their parts (text,
+media, or metadata).
+
+Key functionalities include:
+
+- Extracting YAML frontmatter and the main template body.
+- Parsing the YAML frontmatter into a structured metadata object, handling
+  reserved keywords and namespaced entries.
+- Splitting the template body into message sources based on role and history
+  markers.
+- Converting message sources into structured messages, processing media and
+  section markers within the content.
+- Handling the insertion of historical messages into the conversation flow.
+"""
 
 import re
 from dataclasses import dataclass, field

python/dotpromptz/tests/dotpromptz/dotprompt_test.py

@@ -556,3 +556,7 @@ def wrapper(
         resolve_metadata_mock.assert_called_with(PromptMetadata(config={'temperature': 0.7}), parsed_source, None)
 
         assert result.config == {'temperature': 0.7}
+
+
+if __name__ == '__main__':
+    unittest.main()