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

Metadata

Release files for flick-framework 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for flick-framework 1.0.0
File Size Uploaded
flick_framework-1.0.0.tar.gz 19.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for flick-framework 1.0.0
File Interpreter ABI Platform
flick_framework-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 29.6 kB

Release files / flick_framework-1.0.0.tar.gz

Download URL flick_framework-1.0.0.tar.gz
Size 19.8 kB
Tags Source
SHA-256 checksum
How to use checksums
54d23dbb842010ada93d450a6bf1d29248733cbac26ec7ae2ebd6149f32d2f24
BLAKE2b-256 checksum
How to use checksums
a13c680e6bb94a17c3cfccec3e335746855c8b6090f71a1cf1e07506d4609012
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.14

Release files / flick_framework-1.0.0-py3-none-any.whl

Download URL flick_framework-1.0.0-py3-none-any.whl
Size 9.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fadb914fbae6b9decad95aae65d49e0c84ccd6a317eefbf6e2dd8b0da888ef2c
BLAKE2b-256 checksum
How to use checksums
76c8e77695a1288b7db2778d8a5839fe2ee0c35224d803975dddfe623dcc4878
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.14

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page