Skip to main content

Serve click scripts over the web with minimal effort.

Project description


Serve click scripts over the web with minimal effort.

Caution: If you plan to serve publicly make sure you setup security (SSL, login etc.) See Authentication


See this demo screen capture.

Take an existing click script, like this one:

import click
import time
def cli():
    'A stupid script to test click-web'

@click.option("--delay", type=float, default=0.01, help='delay for every line print')
@click.argument("lines", default=10, type=int)
def print_rows(lines, delay):
    'Print lines with a delay'
    click.echo(f"writing: {lines} with {delay}")
    for i in range(lines):
        click.echo(f"Hello row: {i}")

if __name__ == '__main__':

Create a minimal script to run with flask

from click_web import create_click_web_app
import example_command

app = create_click_web_app(example_command, example_command.cli)

Running example app:

In Bash:

export FLASK_ENV=development
flask run


For an example of how to secure using http digest auth see the auth example.

Note: There is no permission system and all logged in users can access everything. If you plan to deploy in an open environment make sure to setup HTTPS.

Custom Styling

For an example of how to customize styling using CSS see the custom css example.

Unsupported click features

It has only been tested with basic click features, and most advanced features will probably not work.

  • Variadic arguments of file and path type
  • Promts (probably never will)
  • Custom ParamTypes (depending on implementation)


  • Abort started/running processes.
  • Browser history

Included 3:rd party libraries

SplitJs - Copyright (c) 2018 Nathan Cahill (MIT license)

Project details

Download files

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

Files for click-web, version 0.7.2
Filename, size File type Python version Upload date Hashes
Filename, size click_web-0.7.2-py3-none-any.whl (44.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size click-web-0.7.2.tar.gz (38.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page