Skip to main content

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

Download files

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

Source Distribution

flick_framework-1.0.0.tar.gz (19.8 kB view details)

Uploaded Source

Built Distribution

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

flick_framework-1.0.0-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for flick_framework-1.0.0.tar.gz
Algorithm Hash digest
SHA256 54d23dbb842010ada93d450a6bf1d29248733cbac26ec7ae2ebd6149f32d2f24
MD5 6b9b008921893fcb71f2808acbb0fb08
BLAKE2b-256 a13c680e6bb94a17c3cfccec3e335746855c8b6090f71a1cf1e07506d4609012

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flick_framework-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fadb914fbae6b9decad95aae65d49e0c84ccd6a317eefbf6e2dd8b0da888ef2c
MD5 161a2a08c88f599f51f5d703afd55a0c
BLAKE2b-256 76c8e77695a1288b7db2778d8a5839fe2ee0c35224d803975dddfe623dcc4878

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 files

Supported by

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