Skip to content
A tool for exploring and publishing data
Python HTML CSS Dockerfile
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
datasette Include rowid in filter select, closes #636 Nov 19, 2019
docs Release notes for 0.32 Nov 14, 2019
tests Include rowid in filter select, closes #636 Nov 19, 2019
.dockerignore Expose current git tag to Docker build, closes #399 Jan 13, 2019
.gitattributes Mark codemirror files as vendored (#367) May 3, 2019
.gitignore New run_sanity_checks mechanism, for SpatiLite May 11, 2019
.isort.cfg
.travis.yml Support Python 3.8, stop supporting Python 3.5 (#627) Nov 12, 2019
Dockerfile Python 3.7.2 as base for Docker image Jan 13, 2019
LICENSE Initial commit Oct 23, 2017
MANIFEST.in Add version number support with Versioneer May 22, 2018
README.md Datasette 0.32 and datasette-template-sql in news Nov 14, 2019
_config.yml Set theme jekyll-theme-architect May 24, 2018
pytest.ini Port Datasette from Sanic to ASGI + Uvicorn (#518) Jun 24, 2019
setup.cfg Add a max-line-length setting for flake8 (#444) May 3, 2019
setup.py Removed code that conditionally installs black Nov 12, 2019
update-docs-help.py Rename "datasette publish now" to "datasette publish nowv1" May 19, 2019
versioneer.py Fix numerous typos (#561) Jul 26, 2019

README.md

Datasette

PyPI Python 3.x Travis CI Documentation Status License Code style: black docker: datasette

A tool for exploring and publishing data

Datasette is a tool for exploring and publishing data. It helps people take data of any shape or size and publish that as an interactive, explorable website and accompanying API.

Datasette is aimed at data journalists, museum curators, archivists, local governments and anyone else who has data that they wish to share with the world.

Explore a demo, watch a video about the project or try it out by uploading and publishing your own CSV data.

News

Installation

pip3 install datasette

Datasette requires Python 3.6 or higher. We also have detailed installation instructions covering other options such as Docker.

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:

Downloads table rendered by datasette

datasette serve options

Usage: datasette serve [OPTIONS] [FILES]...

  Serve up specified SQLite database files with a web UI

Options:
  -i, --immutable PATH      Database files to open in immutable mode
  -h, --host TEXT           Host for server. Defaults to 127.0.0.1 which means
                            only connections from the local machine will be
                            allowed. Use 0.0.0.0 to listen to all IPs and
                            allow access from other machines.
  -p, --port INTEGER        Port for server, defaults to 8001
  --debug                   Enable debug mode - useful for development
  --reload                  Automatically reload if database or code change
                            detected - useful for development
  --cors                    Enable CORS by serving Access-Control-Allow-
                            Origin: *
  --load-extension PATH     Path to a SQLite extension to load
  --inspect-file TEXT       Path to JSON file created using "datasette
                            inspect"
  -m, --metadata FILENAME   Path to JSON file containing license/source
                            metadata
  --template-dir DIRECTORY  Path to directory containing custom templates
  --plugins-dir DIRECTORY   Path to directory containing custom plugins
  --static STATIC MOUNT     mountpoint:path-to-directory for serving static
                            files
  --memory                  Make :memory: database available
  --config CONFIG           Set config option using configname:value
                            datasette.readthedocs.io/en/latest/config.html
  --version-note TEXT       Additional note to show on /-/versions
  --help-config             Show available config options
  --help                    Show this message and exit.

metadata.json

If you want to include licensing and source information in the generated datasette website you can do so using a JSON file that looks something like this:

{
    "title": "Five Thirty Eight",
    "license": "CC Attribution 4.0 License",
    "license_url": "http://creativecommons.org/licenses/by/4.0/",
    "source": "fivethirtyeight/data on GitHub",
    "source_url": "https://github.com/fivethirtyeight/data"
}

Save this in metadata.json and run Datasette like so:

datasette serve fivethirtyeight.db -m metadata.json

The license and source information will be displayed on the index page and in the footer. They will also be included in the JSON produced by the API.

datasette publish

If you have Heroku, Google Cloud Run or Zeit Now v1 configured, Datasette can deploy one or more SQLite databases to the internet with a single command:

datasette publish heroku database.db

Or:

datasette publish cloudrun database.db

This will create a docker image containing both the datasette application and the specified SQLite database files. It will then deploy that image to Heroku or Cloud Run and give you a URL to access the resulting website and API.

See Publishing data in the documentation for more details.

You can’t perform that action at this time.