Skip to main content

Python implementation of the client/server L402 protocol flow

Project description

L402 Python Library

This library simplifies the integration of internet-native paywalls into your Python applications by providing a client and server implementation of the L402 protocol.

HTTP servers like Flask and FastAPI can easily authorize and charge for requests, while clients can automatically gain access to protected services by obtaining credentials and paying invoices.

For learning more about the protocol, visit [l402.org]

Features

  • Built on top of the HTTP 402 Payment Required error code
  • Fine-grained authorization policies using Macaroons, giving you granular control over service access
  • Secure, fast, and cheap payments powered by the Lightning Network
  • Allows payments as small as a fraction of a cent
  • Machine-friendly design, perfect for seamless integration with AI-driven applications
  • Async-first architecture for optimal performance
  • Includes decorators and middlewares for popular HTTP servers: Flask, FastAPI, and Django
  • Drop-in replacement for the httpx client, making it easy to access protected services

Installation

The package is available at pypi and be installed with pip.

pip install l402

Usage

Client

To make requests that can handle 402 Payment Required responses:

from l402.client import httpx

# Configure the client with a preimage provider and credentials service.
httpx.configure(
    preimage_provider=MyPreimageProvider(),
    credentials_service=MyCredentialsService()
)

# Make a request
async with httpx.AsyncClient() as client:
    response = await client.get("https://example.com/protected")

Server

To protect routes and require payment:

from flask import Flask
from l402.server import Authenticator, Flask_l402_decorator

app = Flask(name)
authenticator = Authenticator(...)

# Paywall a route with a 1 USD cent payment required.
def pricing_func(amount: int, currency: str, description: str):
    price_in_cents = 1
    return price_in_cents, "USD", "L402 challenge"

@app.route('/protected')
@Flask_l402_decorator(authenticator, pricing_func)
def protected_route():
    return "Protected content"

Tutorial

If you want to learn more about the L402 protocol, how to set it up in your own server, or how to use the client library, we have a notebook tutorial to help you get started:

We'll guide you through the process step by step, providing code examples and explanations along the way. By the end of this tutorial, you'll have a solid understanding of how to integrate internet-native paywalls into your Python applications using the L402 Python Library

Contributing

Contributions are welcome! Please see the contributing guide for more information.

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

l402-0.0.6.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

l402-0.0.6-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file l402-0.0.6.tar.gz.

File metadata

  • Download URL: l402-0.0.6.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Darwin/23.4.0

File hashes

Hashes for l402-0.0.6.tar.gz
Algorithm Hash digest
SHA256 f5316705b95c5d4a430edbcc57c702808906a9cb8ab338a4c0e9dc371beceb05
MD5 95a3c028af65db9179fe87ee716e18ae
BLAKE2b-256 c7b55b4b81a8cdfa0cb05c397284ccdedcdc8fc7e8e528f15e2717cf07c0156d

See more details on using hashes here.

File details

Details for the file l402-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: l402-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 20.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Darwin/23.4.0

File hashes

Hashes for l402-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b883d9819b37df23212c7834dc4fd7760b14cbf94ffc9e2e233f8aeaad6d50a5
MD5 30807177abd42bc24211d1c7e87eca1d
BLAKE2b-256 ac88ae2fa81b37388f82a1bd673c2032eec31fbd753479f6df59351a3bdca3d6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page