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.0.tar.gz (10.2 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.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: floydr-1.0.0.tar.gz
  • Upload date:
  • Size: 10.2 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.0.tar.gz
Algorithm Hash digest
SHA256 26f90228a628ad420b2ded410c9e2b4d20ffe654e654573eb568bdd7cb2d9ee0
MD5 4f3a09af3b24364b4f89f2497ab15361
BLAKE2b-256 7ab23f105d89810a3b87b517d20831512445850443ee4278a5d9330cd998c0fb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: floydr-1.0.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64365b3ae28bb0c1c046c42da70bb9b02de19db00c5b584cd47bf37bcf76a5c8
MD5 6679fddea0e7fc8b06fe86d75033292c
BLAKE2b-256 3b902c8f8b6cf42d6808d955728728931d84472cf2c014f106cfde3871e344d0

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