Skip to main content

A zero-boilerplate framework for building interactive ChatGPT widgets

Project description

Flick

A zero-boilerplate framework for building interactive ChatGPT widgets.

Features

  • 🚀 Zero Configuration - Just create your widget and tool, everything else is automated
  • 🔄 Auto-Discovery - Tools are automatically detected and registered
  • 📦 Auto-Build - Mounting logic injected at build time
  • ⚡ Hot Reload - Changes detected and rebuilt automatically
  • 🎨 React + Vite - Modern frontend development experience

Installation

pip install flick

Quick Start

from flick import BaseWidget
from pydantic import BaseModel, ConfigDict
from typing import Dict, Any

class MyWidgetInput(BaseModel):
    model_config = ConfigDict(populate_by_name=True)

class MyWidgetTool(BaseWidget):
    identifier = "my_widget"
    title = "My Widget"
    input_schema = MyWidgetInput
    
    async def execute(self, input_data: MyWidgetInput) -> Dict[str, Any]:
        return {"message": "Hello from Flick!"}

Create your React component in widgets/my_widget/index.jsx:

import React from 'react';
import { useWidgetProps } from 'flick-react';

export default function MyWidget() {
  const { message } = useWidgetProps();
  return <h1>{message}</h1>;
}

That's it! No boilerplate files needed.

Documentation

Visit flick.dev/docs for full documentation.

License

MIT

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

floydr-1.0.3.tar.gz (21.3 kB view details)

Uploaded Source

Built Distribution

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

floydr-1.0.3-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file floydr-1.0.3.tar.gz.

File metadata

  • Download URL: floydr-1.0.3.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for floydr-1.0.3.tar.gz
Algorithm Hash digest
SHA256 e7423388e6785708b6d847f0d4a3e5f9cd3552d2cf817cfb010b446a38db253e
MD5 2f09dd3c905fc0fb4dc8a9f8473ab249
BLAKE2b-256 b044b95ed331a02f9ba67f598807fb86a5d8f5682572aef010898ea2bff8da01

See more details on using hashes here.

File details

Details for the file floydr-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: floydr-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for floydr-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4c09a7a394ea823b8de7c15c56ae6a7d08e0f066d6b9261213e96f6357545cee
MD5 a0c3c39709406010e6ebcb50d792ca01
BLAKE2b-256 ed60cdd71d63730a1ab5a2fa6335f462342a57a8e85df238767202bfe8f9562a

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