feat: add comprehensive tests, examples, and documentation#2
Merged
Conversation
- Add examples directory with practical usage examples: - basic_usage.py: Loading packs, templates, and formatting - tools_example.py: Tool conversion and LangChain integration - validation_example.py: Output validation with various validators - Example PromptPack JSON files (customer-support, sales-assistant) - Add comprehensive unit tests: - test_multimodal.py: 19 tests for multimodal content conversion - Enhanced test_template.py: Model overrides, defaults, async support - Enhanced test_validators.py: Multiple validators, edge cases - Update CI pipeline (.github/workflows/ci.yml): - Add Python 3.13 to test matrix - Add linting for examples directory - Add coverage reporting with Codecov - Add examples verification job - Update documentation (Astro/Starlight): - Add Examples section with 4 detailed guides - Update quickstart with validation examples - Add Output Validation feature card - Configure ruff to allow print statements in examples Test count: 131 tests (60 promptpack + 71 promptpack-langchain)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
Examples (
examples/)Tests
CI Pipeline (
.github/workflows/ci.yml)Documentation (
docs/)Test plan
ruff checkandruff format --check)mypy)