Skip to main content

framelib

lightweight library for building farcaster frames using python and flask

  • easily render frames that conform to the farcaster specification
  • configurable frame design
  • parse frame action messages
  • verify the frame action signatures using neynar
  • query user profile info from warpcast
  • on-chain frame transactions

quickstart

install framelib from pip

pip install framelib

simple example

from flask import Flask, url_for
from framelib import frame

app = Flask(__name__)

@app.route('/')
def home():
    return frame(
        image='https://opengraph.githubassets.com/0x/devinaconley/python-frames',
        button1='next',
        post_url=url_for('second_page', _external=True),
    )

examples

see a complete example using python + flask + vercel here

for an example that uses on-chain frame transactions, see the weth frame

and for a more advanced example involving multiplayer games, supabase integration, dynamic image rendering, and more, see rock paper scissors

roadmap

upcoming features and improvements

  • mint actions
  • eip 712 signatures
  • generated library documentation
  • dynamic image rendering tools
  • compatibility with other web frameworks
  • state signing

Metadata

Release files for framelib 0.0.6

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

Source distribution (sdist)

Source distribution for framelib 0.0.6
File Size Uploaded Provenance
framelib-0.0.6.tar.gz 9.4 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for framelib 0.0.6
File Interpreter ABI Platform
framelib-0.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 20.9 kB

Release files / framelib-0.0.6.tar.gz

Download URL framelib-0.0.6.tar.gz
Size 9.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a54d585487de1eda71315456957fdd1fd81876d19e94e33c04a3a008b4eacaba
BLAKE2b-256 checksum
How to use checksums
5d2624ed2b6f28ac53ed97ab5de6eb50fa69f5a34847797451aba62390b4183f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 27, 2024.

Transparency log

Release files / framelib-0.0.6-py3-none-any.whl

Download URL framelib-0.0.6-py3-none-any.whl
Size 11.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
355455b777efeab9ee69fe30618e3dc4d793cfa6af75a11a0c16b0b5322d1dcd
BLAKE2b-256 checksum
How to use checksums
250731f5977989033f808d0506d0dea24158df16c23d030938facac050d9c2aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 27, 2024.

Transparency log

Security for framelib 0.0.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for framelib-0.0.6.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 27, 2024.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

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