An open source multi-tool for exploring and publishing data
 
 
 
 
 
 
Go to file
Simon Willison 645381a5ed Add code of conduct again
Refs #1658
2022-03-15 08:38:42 -07:00
.github Test against Python 3.11-dev 2022-02-02 13:58:52 -08:00
datasette Revert "Fix bug with percentage redirects, close #1650" 2022-03-15 08:37:31 -07:00
demos/apache-proxy datasette-debug-asgi plugin to help investigate #1590 2022-01-13 16:38:53 -08:00
docs Switch to dash encoding for table/database/row-pk in paths 2022-03-07 07:38:29 -08:00
tests Revert "Fix bug with percentage redirects, close #1650" 2022-03-15 08:37:31 -07:00
.coveragerc
.dockerignore Build Dockerfile with SpatiaLite 5, refs #1249 2021-03-26 21:27:40 -07:00
.gitattributes New explicit versioning mechanism 2020-10-28 20:38:15 -07:00
.gitignore New get_metadata() plugin hook for dynamic metadata 2021-06-26 15:24:54 -07:00
.isort.cfg
.prettierrc .prettierrc, refs #1166 2020-12-31 13:25:44 -08:00
.readthedocs.yaml Remove python.version, refs #1176 2022-02-06 22:40:47 -08:00
CODE_OF_CONDUCT.md Add code of conduct again 2022-03-15 08:38:42 -07:00
Dockerfile Upgrade Docker base to Debian buster, refs #1497 2021-10-24 16:24:41 -07:00
LICENSE
MANIFEST.in Include LICENSE in sdist (#1043) 2020-10-23 13:54:34 -07:00
README.md It's not a weekly newsletter 2022-01-26 10:21:05 -08:00
codecov.yml codecov should not be blocking 2020-07-02 21:29:32 -07:00
package-lock.json Install Prettier via package.json (#1170) 2021-01-04 11:52:33 -08:00
package.json Easier way to run Prettier locally (#1203) 2021-01-24 17:41:46 -08:00
pytest.ini asyncio_mode = strict to avoid pytest warnings 2022-03-07 08:09:15 -08:00
setup.cfg New explicit versioning mechanism 2020-10-28 20:38:15 -07:00
setup.py Update pytest-timeout requirement from <2.1,>=1.4.2 to >=1.4.2,<2.2 (#1602) 2022-03-05 17:41:49 -08:00

README.md

Datasette

PyPI Changelog Python 3.x Tests Documentation Status License docker: datasette

An open source multi-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, scientists, researchers 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.

Want to stay up-to-date with the project? Subscribe to the Datasette newsletter for tips, tricks and news on what's new in the Datasette ecosystem.

Installation

If you are on a Mac, Homebrew is the easiest way to install Datasette:

brew install datasette

You can also install it using pip or pipx:

pip install datasette

Datasette requires Python 3.7 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

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 or Google Cloud Run 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.