An open source multi-tool for exploring and publishing data
 
 
 
 
 
 
Go to file
Simon Willison 93534fd3d0 Show response.text on test_upsert failure, refs #2356 2024-06-13 10:19:26 -07:00
.github Test against multiple SQLite versions (#2352) 2024-06-13 10:09:45 -07:00
datasette Removed unnecessary comments, refs #2354 2024-06-12 16:56:59 -07:00
demos Fixed an unnecessary f-string 2024-02-04 10:15:21 -08:00
docs named_parameters(sql) sync function, refs #2354 2024-06-12 16:51:07 -07:00
tests Show response.text on test_upsert failure, refs #2356 2024-06-13 10:19:26 -07:00
.coveragerc Configure code coverage, refs #841, #843 2020-06-13 13:48:23 -07:00
.dockerignore Build Dockerfile with SpatiaLite 5, refs #1249 2021-03-26 21:27:40 -07:00
.git-blame-ignore-revs Ignore Black commits in git blame, refs #1716 2022-04-22 14:58:46 -07:00
.gitattributes New explicit versioning mechanism 2020-10-28 20:38:15 -07:00
.gitignore Add new entrypoint option to --load-extensions. (#1789) 2022-08-23 11:34:30 -07:00
.isort.cfg Used isort to re-order my imports 2018-05-14 00:04:23 -03:00
.prettierrc .prettierrc, refs #1166 2020-12-31 13:25:44 -08:00
.readthedocs.yaml Build docs with 3.11 on ReadTheDocs 2023-05-07 11:44:27 -07:00
CODE_OF_CONDUCT.md Add code of conduct again 2022-03-15 08:38:42 -07:00
Dockerfile Upgrade Docker images to Python 3.11, closes #1853 2022-10-25 12:04:53 -07:00
Justfile fix (typo): Corrected spelling of 'environments' (#2268) 2024-02-19 14:41:32 -08:00
LICENSE Initial commit 2017-10-22 17:39:03 -07:00
MANIFEST.in Include LICENSE in sdist (#1043) 2020-10-23 13:54:34 -07:00
README.md Link to /en/latest/ changelog 2024-02-07 22:53:14 -08:00
codecov.yml codecov should not be blocking 2020-07-02 21:29:32 -07:00
package-lock.json Upgrade to CodeMirror 6, add SQL autocomplete (#1893) 2022-11-16 15:49:06 -08:00
package.json Prettier should ignore bundle.js file - refs #1893 2022-11-16 15:53:27 -08:00
pytest.ini Drop support for Python 3.7, refs #2097 2023-07-08 11:40:19 -07:00
ruff.toml Fixed a bunch of unused imports spotted with ruff 2024-02-06 17:27:20 -08:00
setup.cfg New explicit versioning mechanism 2020-10-28 20:38:15 -07:00
setup.py Bump the python-packages group with 1 update (#2269) 2024-02-19 14:23:12 -08:00
test-in-pyodide-with-shot-scraper.sh Fix for pyodide test failure, refs #2351 2024-06-11 10:11:34 -07:00

README.md

Datasette

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

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.8 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 --nolock

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.

Datasette Lite

Datasette Lite is Datasette packaged using WebAssembly so that it runs entirely in your browser, no Python web application server required. Read more about that in the Datasette Lite documentation.