From e6ca88588395a9b8266c0e14121668990d34ff67 Mon Sep 17 00:00:00 2001 From: Simon Willison Date: Thu, 16 Nov 2017 07:11:00 -0800 Subject: [PATCH] Added initial docs, including a changelog Docs initialized using this helpful guide: http://docs.readthedocs.io/en/latest/getting_started.html I used https://pypi.python.org/pypi/gitchangelog to kick-start the changelog. Closes #99 Refs #109 --- docs/.gitignore | 1 + docs/Makefile | 20 ++++++ docs/changelog.rst | 52 ++++++++++++++ docs/conf.py | 169 +++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 123 +++++++++++++++++++++++++++++++++ 5 files changed, 365 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/Makefile create mode 100644 docs/changelog.rst create mode 100644 docs/conf.py create mode 100644 docs/index.rst diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..e35d8850 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +_build diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..dbb89483 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = Datasette +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 00000000..2398f90a --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,52 @@ +Changelog +========= + +0.11 (2017-11-14) +----------------- +- Added ``datasette publish now --force`` option. + + This calls ``now`` with ``--force`` - useful as it means you get a fresh copy of datasette even if Now has already cached that docker layer. +- Enable ``--cors`` by default when running in a container. + + +0.10 (2017-11-14) +----------------- +- Fixed `#83`_ - 500 error on individual row pages. +- Stop using sqlite WITH RECURSIVE in our tests. + + The version of Python 3 running in Travis CI doesn't support this. + +.. _#83: https://github.com/simonw/datasette/issues/83 + +0.9 (2017-11-13) +---------------- +- Added ``--sql_time_limit_ms`` and ``--extra-options``. + + 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 resulting Docker containers. + +0.8 (2017-11-13) +---------------- +- V0.8 - added PyPI metadata, ready to ship. +- Implemented offset/limit pagination for views (`#70`_). +- Improved pagination. (`#78`_) +- Limit on max rows returned, controlled by ``--max_returned_rows`` option. (`#69`_) + + If someone executes 'select * from table' against a table with a million rows + in it, we could run into problems: just serializing that much data as JSON is + likely to lock up the server. + + Solution: we now have a hard limit on the maximum number of rows that can be + returned by a query. If that limit is exceeded, the server will return a + ``"truncated": true`` field in the JSON. + + This limit can be optionally controlled by the new ``--max_returned_rows`` + option. Setting that option to 0 disables the limit entirely. + +.. _#70: https://github.com/simonw/datasette/issues/70 +.. _#78: https://github.com/simonw/datasette/issues/78 +.. _#69: https://github.com/simonw/datasette/issues/69 \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..60b72a11 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,169 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Datasette documentation build configuration file, created by +# sphinx-quickstart on Thu Nov 16 06:50:13 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'Datasette' +copyright = '2017, Simon Willison' +author = 'Simon Willison' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '' +# The full version, including alpha/beta/rc tags. +release = '' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Datasettedoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'Datasette.tex', 'Datasette Documentation', + 'Simon Willison', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'datasette', 'Datasette Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'Datasette', 'Datasette Documentation', + author, 'Datasette', 'One line description of project.', + 'Miscellaneous'), +] + + + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..623eb27c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,123 @@ +Datasette +========= + +*An instant JSON API for your SQLite databases* + +Datasette provides an instant, read-only JSON API for any SQLite +database. It also provides tools for packaging the database up as a +Docker container and deploying that container to hosting providers such +as `Zeit Now`_. + +Some examples: https://github.com/simonw/datasette/wiki/Datasettes + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + + changelog + +Getting started +--------------- + +:: + + pip3 install datasette + +Datasette requires Python 3.5 or higher. + +Basic usage +----------- + +:: + + datasette serve path/to/database.db + +This will start a web server on port 8001 - visit http://localhost:8001/ +to access the web interface. + +``serve`` is the default subcommand, you can omit it if you like. + +Use Chrome on OS X? You can run datasette against your browser history +like so: + +:: + + datasette ~/Library/Application\ Support/Google/Chrome/Default/History + +Now visiting http://localhost:8001/History/downloads will show you a web +interface to browse your downloads data: + +.. figure:: https://static.simonwillison.net/static/2017/datasette-downloads.png + :alt: Downloads table rendered by datasette + +http://localhost:8001/History/downloads.json will return that data as +JSON: + +:: + + { + "database": "History", + "columns": [ + "id", + "current_path", + "target_path", + "start_time", + "received_bytes", + "total_bytes", + ... + ], + "table_rows": 576, + "rows": [ + [ + 1, + "/Users/simonw/Downloads/DropboxInstaller.dmg", + "/Users/simonw/Downloads/DropboxInstaller.dmg", + 13097290269022132, + 626688, + 0, + ... + ] + ] + } + +http://localhost:8001/History/downloads.jsono will return that data as +JSON in a more convenient but less efficient format: + +:: + + { + ... + "rows": [ + { + "start_time": 13097290269022132, + "interrupt_reason": 0, + "hash": "", + "id": 1, + "site_url": "", + "referrer": "https://www.dropbox.com/downloading?src=index", + ... + } + ] + } + +datasette serve options +----------------------- + +:: + + $ datasette serve --help + Usage: datasette serve [OPTIONS] [FILES]... + + Serve up specified SQLite database files with a web UI + + Options: + -h, --host TEXT host for server, defaults to 127.0.0.1 + -p, --port INTEGER port for server, defaults to 8001 + --debug Enable debug mode - useful for development + --reload Automatically reload if code change detected - + useful for development + --cors Enable CORS by + +.. _Zeit Now: https://zeit.co/now