mirror of
https://github.com/simonw/datasette.git
synced 2025-12-10 16:51:24 +01:00
1e698787a4
The serve command now accepts --sql_time_limit_ms for customizing the SQL time limit. The publish and package commands now accept --extra-options which can be used to specify additional options to be passed to the datasite serve command when it executes inside the rusulting Docker containers.
134 lines
4.8 KiB
Python
134 lines
4.8 KiB
Python
import click
|
|
from click_default_group import DefaultGroup
|
|
import json
|
|
import shutil
|
|
from subprocess import call
|
|
import sys
|
|
from .app import Datasette
|
|
from .utils import (
|
|
temporary_docker_directory,
|
|
)
|
|
|
|
|
|
@click.group(cls=DefaultGroup, default='serve', default_if_no_args=True)
|
|
def cli():
|
|
"""
|
|
Datasette!
|
|
"""
|
|
|
|
|
|
@cli.command()
|
|
@click.argument('files', type=click.Path(exists=True), nargs=-1)
|
|
@click.option('--inspect-file', default='inspect-data.json')
|
|
def build(files, inspect_file):
|
|
app = Datasette(files)
|
|
open(inspect_file, 'w').write(json.dumps(app.inspect(), indent=2))
|
|
|
|
|
|
@cli.command()
|
|
@click.argument('publisher', type=click.Choice(['now']))
|
|
@click.argument('files', type=click.Path(exists=True), nargs=-1)
|
|
@click.option(
|
|
'-n', '--name', default='datasette',
|
|
help='Application name to use when deploying to Now'
|
|
)
|
|
@click.option(
|
|
'-m', '--metadata', type=click.File(mode='r'),
|
|
help='Path to JSON file containing metadata to publish'
|
|
)
|
|
@click.option('--extra-options', help='Extra options to pass to datasette serve')
|
|
def publish(publisher, files, name, metadata, extra_options):
|
|
"""
|
|
Publish specified SQLite database files to the internet along with a datasette API.
|
|
|
|
Only current option for PUBLISHER is 'now'. You must have Zeit Now installed:
|
|
https://zeit.co/now
|
|
|
|
Example usage: datasette publish now my-database.db
|
|
"""
|
|
if not shutil.which('now'):
|
|
click.secho(
|
|
' The publish command requires "now" to be installed and configured ',
|
|
bg='red',
|
|
fg='white',
|
|
bold=True,
|
|
err=True,
|
|
)
|
|
click.echo('Follow the instructions at https://zeit.co/now#whats-now', err=True)
|
|
sys.exit(1)
|
|
|
|
with temporary_docker_directory(files, name, metadata, extra_options):
|
|
call('now')
|
|
|
|
|
|
@cli.command()
|
|
@click.argument('files', type=click.Path(exists=True), nargs=-1, required=True)
|
|
@click.option(
|
|
'-t', '--tag',
|
|
help='Name for the resulting Docker container, can optionally use name:tag format'
|
|
)
|
|
@click.option(
|
|
'-m', '--metadata', type=click.File(mode='r'),
|
|
help='Path to JSON file containing metadata to publish'
|
|
)
|
|
@click.option('--extra-options', help='Extra options to pass to datasette serve')
|
|
def package(files, tag, metadata, extra_options):
|
|
"Package specified SQLite files into a new datasette Docker container"
|
|
if not shutil.which('docker'):
|
|
click.secho(
|
|
' The package command requires "docker" to be installed and configured ',
|
|
bg='red',
|
|
fg='white',
|
|
bold=True,
|
|
err=True,
|
|
)
|
|
sys.exit(1)
|
|
with temporary_docker_directory(files, 'datasette', metadata, extra_options):
|
|
args = ['docker', 'build']
|
|
if tag:
|
|
args.append('-t')
|
|
args.append(tag)
|
|
args.append('.')
|
|
call(args)
|
|
|
|
|
|
@cli.command()
|
|
@click.argument('files', type=click.Path(exists=True), nargs=-1)
|
|
@click.option('-h', '--host', default='0.0.0.0', help='host for server, defaults to 0.0.0.0')
|
|
@click.option('-p', '--port', default=8001, help='port for server, defaults to 8001')
|
|
@click.option('--debug', is_flag=True, help='Enable debug mode - useful for development')
|
|
@click.option('--reload', is_flag=True, help='Automatically reload if code change detected - useful for development')
|
|
@click.option('--cors', is_flag=True, help='Enable CORS by serving Access-Control-Allow-Origin: *')
|
|
@click.option('--page_size', default=100, help='Page size - default is 100')
|
|
@click.option('--max_returned_rows', default=1000, help='Max allowed rows to return at once - default is 1000. Set to 0 to disable check entirely.')
|
|
@click.option('--sql_time_limit_ms', default=1000, help='Max time allowed for SQL queries in ms')
|
|
@click.option('--inspect-file', help='Path to JSON file created using "datasette build"')
|
|
@click.option('-m', '--metadata', type=click.File(mode='r'), help='Path to JSON file containing license/source metadata')
|
|
def serve(files, host, port, debug, reload, cors, page_size, max_returned_rows, sql_time_limit_ms, inspect_file, metadata):
|
|
"""Serve up specified SQLite database files with a web UI"""
|
|
if reload:
|
|
import hupper
|
|
hupper.start_reloader('datasette.cli.serve')
|
|
|
|
inspect_data = None
|
|
if inspect_file:
|
|
inspect_data = json.load(open(inspect_file))
|
|
|
|
metadata_data = None
|
|
if metadata:
|
|
metadata_data = json.loads(metadata.read())
|
|
|
|
click.echo('Serve! files={} on port {}'.format(files, port))
|
|
ds = Datasette(
|
|
files,
|
|
cache_headers=not debug and not reload,
|
|
cors=cors,
|
|
page_size=page_size,
|
|
max_returned_rows=max_returned_rows,
|
|
sql_time_limit_ms=sql_time_limit_ms,
|
|
inspect_data=inspect_data,
|
|
metadata=metadata_data,
|
|
)
|
|
# Force initial hashing/table counting
|
|
ds.inspect()
|
|
ds.app().run(host=host, port=port, debug=debug)
|