datasette README

The project's README from github.com/simonw/datasette. As one markdown file: 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 on GitHub Codespaces.

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.

datasette (simonw/datasette)

Searching Database…

11.5K ·GitHub
Datasette
Что это такое?Datasette — это универсальный инструмент с открытым исходным кодом для изучения и публикации данных: укажите ему базу данных SQLite, и он превратит её в интерактивный веб-сайт для просмотра данных с сопутствующим JSON API.
Это инструмент командной строки, веб-приложение или и то, и другое?Это инструмент командной строки, который вы запускаете локально, например `datasette serve path/to/database.db`. После этого он поднимает веб-сервер, который предоставляет и удобный веб-интерфейс для просмотра, и JSON API для этой базы данных.
Как установить это и запустить базу данных?На Mac можно выполнить `brew install datasette`, а на других системах — `pip install datasette` или pipx. Затем запустите `datasette serve path/to/database.db`, чтобы просматривать данные на локальном веб-сервере.
Нужно ли сначала установить Python?Да, Datasette требует Python 3.8 или выше, если вы устанавливаете его через pip или pipx. Установки через Homebrew и Docker включают Python автоматически.
Работает ли он с любой базой данных или только с SQLite?Datasette создан специально для баз данных SQLite: вы указываете ему файлы `.db`, а не подключаетесь к серверам Postgres или MySQL.
Для кого это предназначено?Для журналистов, работающих с данными, кураторов музеев, архивистов, местных органов власти, учёных, исследователей и всех, кто хочет открыто поделиться своими данными.
Как опубликовать данные в интернете, а не только запускать их локально?Команда `datasette publish` одной командой разворачивает образ Docker с Datasette и вашим файлом SQLite прямо на Heroku или Google Cloud Run. В результате вы получаете живую ссылку (URL) и API.
Что такое Datasette Lite?Это Datasette, скомпилированный в WebAssembly, поэтому он работает целиком в вашем браузере и не требует никакого серверов на Python.
Как добавить информацию о лицензии и источниках на опубликованный сайт?Создайте файл metadata.json с полями title, license, licenseurl, source и sourceurl и передайте его командой `-m metadata.json`. Эта информация появится в подвале сайта и в ответах API.
Можно ли использовать его с уже имеющимися данными, например с историей браузера?Да, например, можно выполнить `datasette ~/Library/Application Support/Google/Chrome/Default/History --nolock`, чтобы просмотреть собственную историю Chrome как пример набора данных.
What are similar projects?nocodb, postgrest, duckdb, prediction-market-analysis, q, visidata, redash, capcut-mate
Which topics is it in?asgi, automatic-api, datasets, csv, wasm, sql, data-science, json, sqlite, rest-api, database, command-line-tool
Creator
simonw
Size
11.1 MB
Stars
11.5K
Updated
CommitOct 12Release0.65.5Sep 16
Age
8y
Commits · 90 Days