Package index • putior

Core Functions

Main functions for extracting annotations and creating diagrams

put(): Scan Source Files for PUT Annotations
put_diagram(): Create Mermaid Diagram from PUT Workflow
put_theme(): Create a Custom Theme Palette for Workflow Diagrams
print(<putior_theme>): Print a putior_theme Object
print(<putior_workflow>): Print a putior workflow
summary(<putior_workflow>): Summarize a putior workflow

Auto-Annotation

Automatic workflow detection and annotation generation

put_auto(): Auto-Annotation Functions for putior
put_generate(): Generate PUT Annotation Comments
put_merge(): Merge Manual and Auto-Detected Annotations

Language Support

Multi-language comment syntax and detection patterns

get_comment_prefix(): Get Comment Prefix for File Extension
get_supported_extensions(): Get All Supported File Extensions
list_supported_languages(): List All Supported Languages
get_detection_patterns(): Get Detection Patterns for a Language
ext_to_language(): Get Language Name from File Extension

MCP/ACP Integration

AI assistant integration via Model Context Protocol and Agent Communication Protocol

putior_mcp_server(): Start putior MCP Server
putior_mcp_tools(): Get putior MCP Tool Definitions
putior_acp_server(): Start putior ACP Server
putior_acp_manifest(): Get putior ACP Agent Manifest
putior_skills(): Access putior Skills for AI Assistants
putior_help(): Quick Reference Help for putior

Interactive Tools

Interactive exploration and debugging

run_sandbox(): Launch putior Interactive Sandbox
set_putior_log_level(): Set putior Log Level

Utilities

Helper and validation functions

is_valid_put_annotation(): Validate PUT annotation syntax
split_file_list(): Split comma-separated file list
get_diagram_themes(): Get available themes for put_diagram

Internal Functions

Internal implementation details (not part of the public API)

LANGUAGE_GROUPS: Language Groups by Comment Syntax
as_putior_workflow(): Add putior_workflow class to a data frame
build_file_pattern(): Build File Pattern for Supported Extensions
convert_results_to_df(): Convert results list to data frame
create_artifact_nodes(): Create artifact nodes for data files
detect_files_from_patterns(): Detect files from pattern list
detect_workflow_elements(): Detect workflow elements in a single file
detection_patterns: Detection Pattern Definitions for Auto-Annotation
empty_auto_result_df(): Create empty result data frame for put_auto
empty_result_df(): Create empty result data frame
extract_file_path_from_line(): Extract file path from a line containing a matched function call
find_block_comment_annotations(): Find PUT annotations inside block comments
generate_annotation_for_file(): Generate annotation text for a single file
generate_click_directives(): Generate Mermaid click directives
generate_click_url(): Generate click URL based on protocol
generate_connections(): Generate connections between nodes
generate_file_subgraphs(): Generate file-based subgraphs
generate_node_definitions(): Generate node definitions for mermaid diagram
generate_node_styling(): Generate node styling based on node types and theme
get_block_comment_syntax(): Get Block Comment Syntax for File Extension
get_c_patterns(): Get C Detection Patterns
get_comment_group(): Get Comment Syntax Group for Extension
get_cpp_patterns(): Get C++ Detection Patterns
get_dockerfile_patterns(): Get Dockerfile Detection Patterns
get_go_patterns(): Get Go Detection Patterns
get_java_patterns(): Get Java Detection Patterns
get_javascript_patterns(): Get JavaScript Detection Patterns
get_julia_patterns(): Get Julia Detection Patterns
get_lua_patterns(): Get Lua Detection Patterns
get_makefile_patterns(): Get Makefile Detection Patterns
get_matlab_patterns(): Get MATLAB Detection Patterns
get_node_shape(): Get node shape characters based on node type
get_python_patterns(): Get Python Detection Patterns
get_r_patterns(): Get R Detection Patterns
get_ruby_patterns(): Get Ruby Detection Patterns
get_rust_patterns(): Get Rust Detection Patterns
get_shell_patterns(): Get Shell Detection Patterns
get_sql_patterns(): Get SQL Detection Patterns
get_theme_colors(): Get color schemes for different themes
get_typescript_patterns(): Get TypeScript Detection Patterns
get_wgsl_patterns(): Get WGSL Detection Patterns
handle_output(): Handle diagram output to different destinations
has_logger(): Check if Logger is Available
infer_node_type(): Infer node type from inputs and outputs
insert_annotation_into_file(): Insert annotation at top of file
is_likely_file_path(): Check if a string looks like a file path
language_registry: Language Comment Syntax Registry
merge_annotations(): Merge manual and auto-detected annotations
normalize_path_for_url(): Normalize file path for URL generation
parse_comma_separated_pairs(): Parse comma-separated pairs while respecting quotes
parse_put_annotation(): Extract PUT Annotation Properties
process_single_file(): Process a single file for PUT annotations
putior-package: putior Package Initialization
putior_acp: ACP Server Integration for putior
putior_log(): Internal Logging Function
putior_logging: Logging Infrastructure for putior
putior_mcp: MCP Server Integration for putior
resolve_label(): Resolve label text for a workflow node
sanitize_node_id(): Sanitize node ID for mermaid compatibility (IMPROVED VERSION)
validate_annotation(): Validate PUT annotation for common issues
with_log_level(): Temporarily Set Log Level for a Code Block