Skip to main content

VibeCheck ISL Studio Python API Server - AI-powered code generation and verification

Project description

VibeCheck ISL Studio Python API

PyPI version Python 3.8+

The official Python API server for VibeCheck ISL Studio, providing AI-powered code generation and verification capabilities.

🚀 Quick Start

Installation

# Install from PyPI
pip install vibecheck-isl-studio

# Or install with development dependencies
pip install vibecheck-isl-studio[dev]

# Or install with QA dependencies
pip install vibecheck-isl-studio[qa]

Usage

# Start the server
vibecheck-isl-server start

# Start on custom port
vibecheck-isl-server start --port 8080

# Start with debug mode
vibecheck-isl-server start --debug

The server will start on http://localhost:8000 by default.

API Endpoints

  • GET /health - Health check
  • POST /api/generate - Generate code from description
  • POST /api/validate - Validate generated code
  • POST /api/chat - Chat with AI assistant

⚙️ Configuration

Set environment variables for API keys:

export OPENAI_API_KEY="your-openai-key"
export ANTHROPIC_API_KEY="your-anthropic-key"

Or pass API keys via HTTP headers:

curl -X POST http://localhost:8000/api/generate \
  -H "Content-Type: application/json" \
  -H "X-OpenAI-API-Key: your-openai-key" \
  -d '{"description": "Build a todo app"}'

🛠️ Development

Setup for Development

# Clone the repository
git clone https://github.com/vibecheck/vibez.git
cd vibez/langchain

# Install in development mode
pip install -e .[dev]

# Run tests
pytest

# Format code
black src/
ruff check src/

# Type checking
mypy src/

CLI Commands

# Check installation
vibecheck-isl-server check

# Install dependencies
vibecheck-isl-server install

# Install with dev dependencies
vibecheck-isl-server install --dev

# Show configuration
vibecheck-isl-server config

# Show configuration with secrets
vibecheck-isl-server config --show-secrets

📚 API Documentation

Generate Code

curl -X POST http://localhost:8000/api/generate \
  -H "Content-Type: application/json" \
  -H "X-OpenAI-API-Key: your-key" \
  -d '{
    "description": "Build a React todo app with TypeScript",
    "template_style": "modern",
    "tech_stack_preferences": {
      "frontend_framework": "react",
      "backend": "nodejs",
      "database": "postgresql"
    }
  }'

Validate Code

curl -X POST http://localhost:8000/api/validate \
  -H "Content-Type: application/json" \
  -d '{
    "files": {
      "src/App.tsx": "import React from 'react';\n\nexport default function App() {\n  return <div>Hello World</div>;\n}"
    },
    "project_type": "web"
  }'

Chat with AI

curl -X POST http://localhost:8000/api/chat \
  -H "Content-Type: application/json" \
  -H "X-OpenAI-API-Key: your-key" \
  -d '{
    "message": "How do I add authentication to my React app?",
    "session_id": "optional-session-id"
  }'

🔧 Configuration Options

Environment Variable Default Description
ISL_STUDIO_HOST 0.0.0.0 Server host
ISL_STUDIO_PORT 8000 Server port
ISL_STUDIO_DEBUG false Debug mode
ISL_STUDIO_LOG_LEVEL INFO Log level
OPENAI_API_KEY - OpenAI API key
ANTHROPIC_API_KEY - Anthropic API key

🤝 Integration with VS Code

The VS Code extension can automatically start this server when needed. No manual installation required - the extension handles everything for you!

📝 License

MIT License - see LICENSE file for details.

🆘 Support


Made with ❤️ by VibeCheck

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vibecheck_isl_studio-1.0.0.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vibecheck_isl_studio-1.0.0-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file vibecheck_isl_studio-1.0.0.tar.gz.

File metadata

  • Download URL: vibecheck_isl_studio-1.0.0.tar.gz
  • Upload date:
  • Size: 14.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for vibecheck_isl_studio-1.0.0.tar.gz
Algorithm Hash digest
SHA256 089512f8678e5cecb9d5b0abbd5c3fc01d9ce42fee6b221185f77419ae2bf2d9
MD5 fbd82c1ed2a922e21dae07ed14e5cfd6
BLAKE2b-256 c974ccb1f7461e545aaf99ce2a213fdf19b5992d1189ef3783a5d4f6e4526b3a

See more details on using hashes here.

File details

Details for the file vibecheck_isl_studio-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for vibecheck_isl_studio-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f5fef70ce2b5316f4c6bc5828142cbba2494b89c2635c9dabd7f2863d104da57
MD5 b4ab953a304965ca13a1a2d62c79c0f8
BLAKE2b-256 ab4cab59afb80b0c4c047bc6f7e9d3527d1a876bd7cc4bd674aa7b5f5836cc9e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page