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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file l402-0.0.4.tar.gz
.
File metadata
- Download URL: l402-0.0.4.tar.gz
- Upload date:
- Size: 13.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.3 Darwin/23.4.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | de6348f9860dadd207f4ca1062d23b3b167d66e9c9b45a11ec05508772906269 |
|
MD5 | 19bf86c5a047bfdac80abfc7e3df4890 |
|
BLAKE2b-256 | d9ef119486be8ef2ffe08b8961856a7171027966ae9d3a96099ce8d32620a722 |
File details
Details for the file l402-0.0.4-py3-none-any.whl
.
File metadata
- Download URL: l402-0.0.4-py3-none-any.whl
- Upload date:
- Size: 19.8 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
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12b8f4f4ec4380b03f9a63260e633ed40543fa2cd0a610131cd6f1632c7dc1de |
|
MD5 | 1fbc57be6d1bd1c5861886f95745dadf |
|
BLAKE2b-256 | 75256684b7e6800464b34df440082ef753fdf895656c8f911d92490a6026c92a |