shapi 0.2.10

Transform shell scripts into production-ready APIs with REST, WebRTC, and gRPC support

✨ shapi

Transform shell scripts into production-ready APIs with REST, WebRTC, and gRPC support

🚀 Quick Start | 📖 Documentation | 💡 Examples | 🤝 Contributing | 📄 License

✨ Features

• 🚀 Instant API Generation: Convert any shell script into a REST API with a single command
• 🤖 AI-Powered: Leverage local LLM (Mistral:7b) for intelligent API generation
• 🐳 Container Ready: Automatic Dockerfile and docker-compose.yml generation
• 🌐 Multi-Protocol: Support for REST, WebRTC, and gRPC APIs
• 🧪 Testing Included: Generated test suites and Ansible playbooks
• 📊 Monitoring: Built-in health checks and status endpoints
• 🔧 Production Ready: Complete with Makefile, monitoring, and deployment configs

Quick Start

Installation

pip install shapi

Generate API Service

# Generate complete service structure
shapi generate /path/to/your/script.sh --name my-service

# Or serve directly
shapi serve /path/to/your/script.sh --name my-service --port 8000

Generated Structure

my-service/
├── main.py              # FastAPI service
├── Dockerfile           # Container configuration
├── docker-compose.yml   # Multi-service setup
├── Makefile            # Build and deployment commands
├── requirements.txt     # Python dependencies
├── test_service.py     # Test suite
├── ansible/
│   └── test.yml        # Infrastructure tests
└── script.sh           # Your original script

Usage Examples

Basic Script Conversion

#!/bin/bash
# hello.sh
echo "Hello, $1!"

Generate the service:

shapi generate hello.sh --name greeting-service
cd greeting-service
python main.py

Access your API:

• Health Check: GET http://localhost:8000/health
• Documentation: GET http://localhost:8000/docs
• Execute Script: POST http://localhost:8000/run

API Endpoints

Every generated service includes:

• GET /health - Service health check
• GET /info - Script information
• POST /run - Execute script (sync/async)
• GET /status/{task_id} - Check async task status
• GET /docs - Interactive API documentation

Example API Request

POST /run
{
  "parameters": {
    "name": "World",
    "verbose": true
  },
  "async_execution": false
}

Docker Deployment

# Build and run with Docker
make docker-build
make docker-run

# Or use docker-compose
docker-compose up -d

Testing

# Run tests
make test

# Or directly
python -m pytest test_service.py -v

Configuration

Create a config.yaml file for advanced configuration:

service:
  name: "my-advanced-service"
  description: "Advanced shell script API"
  version: "1.0.0"
  
protocols:
  rest: true
  grpc: true
  webrtc: true
  
security:
  auth_required: false
  cors_enabled: true
  
monitoring:
  health_check_interval: 30
  metrics_enabled: true

CLI Commands

# Generate service structure
shapi generate hello.sh --name service-name --output ./output

# Serve script directly
shapi serve hello.sh --host 0.0.0.0 --port 8008

# Test generated service
shapi test ./generated/service-name

# Build Docker image
shapi build ./generated/service-name

Advanced Features

Async Execution

# Enable async execution for long-running scripts
response = requests.post("/run", json={
    "parameters": {"input": "data"},
    "async_execution": True
})

task_id = response.json()["task_id"]

# Check status
status = requests.get(f"/status/{task_id}")

Multiple Protocols

The generated service supports multiple communication protocols:

• REST API: Standard HTTP endpoints
• WebRTC: Real-time data streaming
• gRPC: High-performance RPC calls

Production Deployment

# Using Makefile
make deploy

# Manual deployment
docker-compose up -d

Requirements

• Python 3.8+
• Docker (optional, for containerization)
• Bash (for shell script execution)

Contributing

Contributions are welcome! Please see our Contributing Guidelines.

License

Apache License 2.0 - see LICENSE file for details.

Support

• 📖 Documentation
• 🐛 Issue Tracker
• 💬 Discussions

---

shapi - From shell to service in seconds! 🚀

Contributing Guidelines

CONTRIBUTING.md

"""

Contributing to shapi

We welcome contributions to shapi! This document provides guidelines for contributing.

Development Setup

1. Clone the repository:

git clone https://github.com/wronai/shapi.git
cd shapi

2. Create virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install in development mode:

pip install -e .[dev]

Running Tests

# Run all tests
pytest

# Run with coverage
pytest --cov=shapi

# Run specific test file
pytest tests/test_core.py -v

Code Style

We use black for code formatting and flake8 for linting:

# Format code
black shapi/

# Check linting
flake8 shapi/

Submitting Changes

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests for new functionality
5. Ensure all tests pass
6. Submit a pull request

Reporting Issues

Please use the GitHub issue tracker to report bugs or request features. """