propact 0.0.3

Protocol Pact: Universal Markdown for Shell/MCP/REST/WS

Propact 🚀 Protocol Pact via Markdown

Markdown speaks all protocols! Shell → MCP → REST/WS without conversion.

pip install propact
propact README.md  # Run this file!

🚀 Quick Start

echo "Shell → MCP → REST pipeline works!"

Features

• Universal Protocol Support: Execute Shell, MCP, REST, and WebSocket protocols directly from Markdown
• Attachment Handling: Manage binary files and images within your protocol documents
• Async Execution: Full async/await support for concurrent protocol execution
• Type Safety: Full type annotations with Pydantic integration
• Modern Python: Built with Python 3.10+ and the latest best practices

Example Usage

import asyncio
from propact import ToonPact

async def main():
    # Load a Protocol Pact document
    pact = ToonPact("README.md")
    
    # Execute all protocols
    results = await pact.execute()
    print(results)
    
    # Execute only shell protocols
    shell_results = await pact.execute(protocol=ProtocolType.SHELL)
    print(shell_results)

asyncio.run(main())

Protocol Blocks

Shell Protocol

echo "Hello from shell!"
ls -la

MCP Protocol

{
  "method": "tools/call",
  "params": {
    "name": "example_tool",
    "arguments": {"input": "test"}
  }
}

REST Protocol

GET https://api.example.com/data
Content-Type: application/json

WebSocket Protocol

{
  "type": "subscribe",
  "channel": "updates"
}

Installation

pip install propact

Or with Poetry:

poetry add propact

Development

# Clone the repository
git clone https://github.com/wronai/propact.git
cd propact

# Install development dependencies
poetry install --with dev

# Run tests
make test

# Run linting
make lint

License

Licensed under Apache-2.0.

Licensed under Apache-2.0.

Apache-2.0 © Tom Sapletta